WebBackend.php

Go to the documentation of this file.

<?php

/***************************************************************************
 *   Copyright (C) 2005-2020 by Ferenc Veres                                                       *
 *   lion@netngine.hu                                                                                                      *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 3 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
 ***************************************************************************/
include('TranslationBackend.php');
include_once('export/ExporterFactory.php');

class WebBackend extends TranslationBackend
{
        public $xStringStack;   
        public $xBrowserHelper; 
        public $chkSearchSelects; 
        function __construct()
        {
                $this->xActiveRootID = (empty($_POST["xActiveRootID"]) ? 0 : $_POST["xActiveRootID"]);
                parent::__construct();
        }

        public function EventHandler()
        {
                global $_POST;
                
                // Handle Events
                $this->Event = (empty($_POST["__Event"]) ? "" : $_POST["__Event"] );

                if($this->Event != "")
                {
                        
                        // Move web variables into local controls

                        $this->xBrowserHelper = (empty($_POST["xBrowserHelper"]) ? "" : $_POST["xBrowserHelper"]);
                        $this->txtEditString = (empty($_POST["txtEditString_".$this->xBrowserHelper]) ? "" : $_POST["txtEditString_".$this->xBrowserHelper] );
                        $this->txtEditString  = trim($this->txtEditString);

                        $this->txtFindText = (empty($_POST["txtFindText"]) ? "" : $_POST["txtFindText"] );
                        $this->ddlFindPercent = (empty($_POST["ddlFindPercent"]) ? 60 : $_POST["ddlFindPercent"]);
                        $this->xStringID = (empty($_POST["xStringID"]) ? 0 : $_POST["xStringID"]);
                        $this->xProjectID = (empty($_POST["xProjectID"]) ? 0 : $_POST["xProjectID"]);
                        $this->ddlLocaleID = (empty($_POST["xOldLocaleID"]) ? "" : $_POST["xOldLocaleID"]);
                        $this->xOldLocaleID = (empty($_POST["xOldLocaleID"]) ? "" : $_POST["xOldLocaleID"]);
                        $this->ddlSearchType = (empty($_POST["ddlSearchType"]) ? 0 : $_POST["ddlSearchType"]);
                        $this->xStringStack = (empty($_POST["xStringStack"]) ? "" : $_POST["xStringStack"]);
                        $this->xDelStringID = (empty($_POST["xDelStringID"]) ? "" : $_POST["xDelStringID"]);
                        $this->xDelProjectID = (empty($_POST["xDelProjectID"]) ? "" : $_POST["xDelProjectID"]);

                        // Store search results checkboxes if any checked (for "save to all checked" operation)
                        if(empty($_POST["chkSearchSelects"]))
                        {
                                unset($this->chkSearchSelects);
                        }
                        else
                        {
                                $this->chkSearchSelects = $_POST["chkSearchSelects"];
                        }

                        // If no valid root yet, try with posted ddlLocaleID too.
                        if($this->xProjectID == 0)
                        {
                                $this->InitLanguage();
                        }

                        //echo "EVENT:".$this->Event;
                        
                        switch($this->Event)
                        {
                                case "find":
                                        $this->Event_FindCustomString();
                                        break;
                                        
                                case "editstring":
                                        $this->Event_EditString();
                                        break;
                                        
                                case "deletestring":
                                        $this->Event_DeleteString();
                                        break;
                                        
                                case "deleteproject":
                                        $this->Event_DeleteProject();
                                        break;
                                
                                case "savenextmissing":
                                case "savepopstack":
                                case "savenext":
                                case "nextmissing":
                                case "next":
                                case "save":
                                case "savetoallchecked":
                                        $this->Event_SaveNavigate();
                                        break;
                                        
                                case "setproject":
                                        $this->Event_SetProject();
                                        break;

                                case "setroot":
                                        $this->Event_SetRoot();
                                        break;

                                case "setlocale":
                                        $this->Event_SetLocale();
                                        break;
                                        
                                case "exportpack":
                                        $this->Event_ExportPack();
                                        break;

                        }
                        

                        // If anything to edit, set browser input field suffix (for browser form cache)
                        if(!empty($this->LocatedString))
                        {
                                $this->xBrowserHelper = md5($this->LocatedString->GetOriginal());
                        }


                }
        }

        private function Event_FindCustomString()
        {
                // Search the string
                $this->FindStrings();

                if($this->xStringID != 0)
                {
                        $this->SyncToString();
                }
                else
                {
                        $this->SyncToProject();
                }
        }


        private function Event_EditString()
        {
                // Load the selected string and related project paths
                $this->SyncToString();
                
                // Find similar strings
                if(!empty($this->LocatedString))
                {
                        $this->ddlSearchType = 0;
                        $this->txtFindText = $this->LocatedString->GetOriginal();
                        $this->FindStrings();
                }
        }

        private function Event_DeleteString()
        {
                $this->DeleteString();
                
                if($this->xDelStringID == $this->xStringID)
                {
                        // If it was the current string, go back to the first in this project.
                        $this->xStringID = 0;
                        $this->SyncToProject();
                }
                else
                {
                        // Not current string, so sync back to that string
                        $this->SyncToString();
                }

                // Search unchanged
                $this->FindStrings();
        }
        
        private function Event_DeleteProject()
        {
                // Deletes project and returns its parent.
                $this->xProjectID = $this->DeleteProject($this->xDelProjectID);
                $this->xStringID = 0;
                $this->SyncToProject();

                // Search unchanged
                $this->FindStrings();
        }

        private function Event_SaveNavigate()
        {
                // Save the string??
                if($this->Event == "savenext" ||
                        $this->Event == "savenextmissing" ||
                        $this->Event == "savepopstack" ||
                        $this->Event == "save" ||
                        $this->Event == "savetoallchecked")
                {
                        $this->SaveString();
                }

                // Save to all checked search result values?
                if($this->Event == "savetoallchecked")
                {
                        if(count($this->chkSearchSelects) > 0)
                        {
                                foreach($this->chkSearchSelects as $stringID)
                                {
                                        // Load each string from the DB, change it and save changes
                                        $string = new TranslationString($stringID);
                                        $string->SetTranslation($this->txtEditString);
                                        $string->Save();
                                }
                        }
                }

                // How to find the next string?
                $locType = LOCATE_CURR;
                
                if($this->Event == "savenext" || $this->Event == "next")
                {
                        $locType = LOCATE_NEXT;
                }
                else if($this->Event == "savenextmissing" || $this->Event == "nextmissing")
                {
                        $locType = LOCATE_NEXTMISSING;
                }
                else if($this->Event == "savepopstack")
                {
                        // Also locate curr, but we take the last string from stack!
                        $locType = LOCATE_CURR;
                        
                        $stack = split(",", $this->xStringStack);
                        $this->xStringID = array_pop($stack);
                        $this->xStringStack = join($stack, ",");
                }
                
                // Locate it on the selected way
                $this->LocateString($locType);

                $this->SyncToString();
                
                // Find similar strings
                if(!empty($this->LocatedString))
                {
                        $this->ddlSearchType = 0;
                        $this->txtFindText = $this->LocatedString->GetOriginal();
                        $this->FindStrings();
                }
        }

        private function Event_SetProject()
        {
                $this->SyncToProject(); 
                
                // Find similar strings
                if(!empty($this->LocatedString))
                {
                        $this->ddlSearchType = 0;
                        $this->txtFindText = $this->LocatedString->GetOriginal();
                        $this->FindStrings();
                }

        }

        private function Event_SetRoot() 
        {
                $id = (empty($_POST["ddlActiveRoot"]) ? "0" : $_POST["ddlActiveRoot"]);

                // Try to load selected root project
                $proj = new TranslationProject();
                if($id && $proj->LoadByID($id, true) && $proj->GetParentID() == 0) 
                {
                        $this->xActiveRootID = $id;
                        $this->xProjectID = $id;
                        $this->SyncToProject();
                } 
                else 
                {
                        throw new Exception("Invalid root project selected to set.");
                }
        }

        private function Event_SetLocale()
        {
                $this->xOldLocaleID = (empty($_POST["ddlLocaleID"]) ? "" : $_POST["ddlLocaleID"]);
                $this->ddlLocaleID = $this->xOldLocaleID;
                $this->InitLanguage();

                $this->SyncToProject();
        }

        private function Event_ExportPack()
        {
                global $CONFIG;

                // Check if exporting is enabled, quit if not
                if(!$CONFIG['enable_web_export'])
                {
                        throw new Exception("Web GUI export function is disabled in configuration.");
                }
                
                // Find selected locale's name
                $localeName = "";
                foreach(TranslationProject::$LocaleIDCache as $name => $id)
                {
                        if($id == $this->ddlLocaleID)
                        {
                                $localeName = $name;
                                break;
                        }
                }

                if($localeName == "")
                {
                        throw new Exception("Cannot find locale name for current locale id: " + $this->ddlLocaleID);
                }

                // Create exporter
                $root = $this->RootProjects[$this->xActiveRootID];
                $factory = new ExporterFactory();
                $proc = $factory->NewExporter($root->GetName());

                // Export to the config.inc.php specified output location
                $proc->Export($localeName, true);
                
                // Compress the dir with TAR
                $languagePack = $localeName."_".date('Y-m-d').".tar.gz";
                system("tar -C ".$CONFIG['export_path']." --exclude $localeName/php -czf ".$CONFIG['language_pack_dir']."/$languagePack $localeName", $ret);
                if($ret != 0)
                {
                        echo("<p>Tar returned $ret, the package may be incomplete.</p>");
                }
                $link = $CONFIG['language_pack_url']."/$languagePack";
                echo("<p>Language pack saved to: <a href=\"$link\">$link</a>.</p>");
        
                // Sync controls
                if($this->xStringID != 0)
                {
                        $this->SyncToString();
                }
                else
                {
                        $this->SyncToProject();
                }
        }

        private function SyncToProject()
        {
                $this->xStringID = 0;
                
                if($this->xProjectID == 0)
                {
                        return;
                }

                // Load the project's strings
                $this->LoadProjectStrings();
                
                if($this->CurrentStrings->valid())
                {
                        // If there are strings, take the first one and Load it
                        $this->xStringID = $this->CurrentStrings->current()->GetStringID();
                        $this->LocateString();

                        // Find similar strings
                        $this->txtFindText = $this->LocatedString->GetOriginal();
                        $this->FindStrings();
                }
                else
                {
                        // Forget last string ID if no strings for this project.
                        $this->xStringID = 0;
                }

                // Load related project tree too
                $this->FindProjectPath();
        }

        private function SyncToString()
        {
                if($this->xStringID == 0)
                {
                        return;
                }
                
                $this->LocateString();
                
                if(!empty($this->LocatedString))
                {
                        // If found the string, load related project info
                        $this->xProjectID = $this->LocatedString->GetProjectID();
                        $this->LoadProjectStrings();
                }

                // Load related project tree too
                $this->FindProjectPath();
        }

}