TranslationProject.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/>. *
 ***************************************************************************/

class TranslationProject
{
        private $ProjectID;     
        private $ParentID;      
        private $RootID;    
        private $Name;          
        private $IsFolder;  
        private $LocaleID;      
        private $Skeleton;      
        private $Document;      
        private $LastSeen;      
        private $Brief;         
        public static $LocaleIDCache; 
        public function __construct($loadByID = 0, $brief = false)
        {
                if($loadByID != 0)
                {
                        $this->LoadByID($loadByID, $brief);
                }
        }

        public static function InitLocaleIDCache()
        {
                $DB =& GetDbConn();
                $Tables =& GetTables();
                
                $rs = $DB->Execute("SELECT ID, Name FROM ".$Tables["Locales"]." ORDER BY Name");
                while($row = $rs->FetchRow()) 
                {
                        TranslationProject::$LocaleIDCache[$row["Name"]] = $row["ID"];
                }
        }

        public static function GetRoots($localeID) 
        {
                $DB =& GetDbConn();
                $Tables =& GetTables();

                $roots = array();
                $rs = $DB->Execute("SELECT ID FROM ".$Tables["Projects"]." WHERE ParentID = 0 AND LocaleID = ? ORDER BY Name", array($localeID));
                while($row = $rs->FetchRow()) 
                {
                        $proj = new TranslationProject();
                        $proj->LoadByID($row["ID"], false);
                        $roots[$row["ID"]] = $proj;
                }
                return $roots;
        }

        private function Clear()
        {
        }

        private function CheckNameCollision()
        {
                $DB =& GetDbConn();
                $Tables =& GetTables();

                $old = $DB->GetOne("SELECT ID FROM ".$Tables["Projects"]." WHERE ParentID = ? AND Name = ? AND LocaleID = ?", array($this->ParentID, $this->Name, $this->LocaleID));
                if($old)
                {
                        return true;
                }
                else
                {
                        return false;
                }

        }

        public function CreateRootProject($name, $localeID)
        {
                return $this->CreateProject(0, 0, $name, true, $localeID);
        }

        public function CreateProject($rootID, $parentID, $name, $isFolder, $localeID, $document = '', $skeleton = '')
        {
                $this->RootID = $rootID;
                $this->ParentID = $parentID;
                $this->Name = $name;
                $this->IsFolder = $isFolder;
                $this->LocaleID = $localeID;
                $this->Document = $document;
                $this->Skeleton = $skeleton;
                $this->LastSeen = time();
                $this->Brief = false; // Newly created project is never brief, as we most likely want to save it
                
                // Project with this name already exists in this Parent?
                if($this->CheckNameCollision())
                {
                        $this->Clear();
                        throw new Exception("Project with this name already exists, same location.");
                }
        }

        public function Save()
        {
                $DB =& GetDbConn();
                $Tables =& GetTables();
                
                if($this->IsFolder && ($this->Document != '' || $this->Skeleton != ''))
                {
                        throw new Exception("Folder project must not contain a document or skeleton.");
                }
                
                if($this->Brief)
                {
                        throw new Exception("Brief=True projects cannot be saved or updated. They are read-only.");
                }
                
                // Is this an already saved project?
                if(isset($this->ProjectID))
                {
                        // Already saved (or a loaded) project, UPDATE in database (except RootID)
                        
                        $ok = $DB->Execute("UPDATE ".$Tables["Projects"]." SET ParentID = ?, Name = ?, IsFolder = ?, LocaleID = ?, OrigDoc = ?, Skeleton = ?, LastSeen = now() WHERE ID = ?", array($this->ParentID, $this->Name, ($this->IsFolder ? 1 : 0), $this->LocaleID, $this->Document, $this->Skeleton, $this->ProjectID));
                }
                else
                {
                        // New project, INSERT into database
                        
                        // Project with this name already exists in this Parent?
                        if($this->CheckNameCollision())
                        {
                                throw new Exception("Project with this name already exists, same location.");
                        }
                        
                        $root = ($this->RootID > 0 ? $this->RootID : null);
                        $ok = $DB->Execute("INSERT INTO ".$Tables["Projects"]." (RootID, ParentID, Name, IsFolder, LocaleID, OrigDoc, Skeleton, LastSeen) VALUES (?,?,?,?,?,?,?, now())", array($root, $this->ParentID, $this->Name, ($this->IsFolder ? 1 : 0), $this->LocaleID, $this->Document, $this->Skeleton));

                        // Get new ID
                        if(!$DB->Insert_ID())
                        {
                                throw new Exception("DB Error: Insert_ID not supported.");
                        }
                        $this->ProjectID = $DB->Insert_ID();
                }

                return $this->ProjectID;
        }

        public function LoadRoot($name, $localeID)
        {
                return $this->Load(0, $name, $localeID, false);
        }

        public function Load($parentID, $name, $localeID, $brief)
        {
                $DB =& GetDbConn();
                $Tables =& GetTables();

                $this->Brief = $brief;
                if($this->Brief)
                {
                        $sql = "SELECT ID, RootID, ParentID, Name, IsFolder, LocaleID,".
                                "TIMESTAMP(LastSeen) as LastSeen ".
                                "FROM ".$Tables["Projects"].
                                " WHERE ParentID = ? AND Name = ? AND LocaleID = ?"; 
                }
                else
                {
                        $sql = "SELECT ID, RootID, ParentID, Name, IsFolder, LocaleID,".
                                "Skeleton, OrigDoc, TIMESTAMP(LastSeen) as LastSeen ".
                                "FROM ".$Tables["Projects"].
                                " WHERE ParentID = ? AND Name = ? AND LocaleID = ?";
                }

                $rs = $DB->Execute($sql, array($parentID, $name, $localeID));
                
                $retVal = $this->LoadRecordSetEntry($rs);
                $rs->Close();

                return $retVal;
        }


        public function LoadFromRecordSet($recordSet, $brief)
        {
                $this->Brief = $brief;
                return $this->LoadRecordSetEntry($recordSet);
        }

        public function LoadByID($projectID, $brief)
        {
                $DB =& GetDbConn();
                $Tables =& GetTables();

                $this->Brief = $brief;
                if($this->Brief)
                {
                        $sql ="SELECT ID, RootID, ParentID, Name, IsFolder, LocaleID,".
                                "TIMESTAMP(LastSeen) as LastSeen ".
                                "FROM ".$Tables["Projects"]." WHERE ID = ?"; 
                }
                else
                {
                        $sql ="SELECT ID, RootID, ParentID, Name, IsFolder, LocaleID,".
                                "Skeleton, OrigDoc, TIMESTAMP(LastSeen) as LastSeen ".
                                "FROM ".$Tables["Projects"]." WHERE ID = ?";
                }
                
                $rs = $DB->Execute($sql, array($projectID));
                
                $retVal = $this->LoadRecordSetEntry($rs);
                $rs->Close();
                
                return $retVal;

        }

        private function LoadRecordSetEntry($rs)
        {
                if($row = $rs->FetchRow())
                {
                        $this->ProjectID = $row["ID"];
                        if($row["RootID"] == null) 
                        {
                                $this->RootID = 0;
                        }
                        else
                        {
                                $this->RootID = $row["RootID"];
                        }
                        $this->ParentID = $row["ParentID"];
                        $this->Name = $row["Name"];
                        $this->IsFolder = ($row["IsFolder"] == 1);
                        $this->LocaleID = $row["LocaleID"];
                        $this->LastSeen = $row["LastSeen"];
                        
                        if($this->Brief)
                        {
                                unset($this->Skeleton);
                                unset($this->Document);
                        }
                        else
                        {
                                $this->Skeleton = $row["Skeleton"];
                                $this->Document = $row["OrigDoc"];
                        }
                        return true;
                }
                else
                {
                        unset($this->ProjectID);
                        unset($this->RootID);
                        unset($this->ParentID);
                        unset($this->Name);
                        unset($this->IsFolder);
                        unset($this->LocaleID);
                        unset($this->Skeleton);
                        unset($this->Document);
                        unset($this->lastSeen);
                        unset($this->ProjectID);
                        return false;
                }
        }

        public function DestroyData()
        {
                $DB =& GetDbConn();
                $Tables =& GetTables();

                $children = new ProjectIterator($this->ProjectID, $this->LocaleID);
                if($children->valid())
                {
                        throw new Exception("Cannot destroy data of project ".$this->ProjectID.", because it has children.");
                }

                $strings = new StringIterator($this->ProjectID);
                if($strings->valid())
                {
                        throw new Exception("Cannot destroy data of project ".$this->ProjectID.", because it contains strings.");
                }
                $DB->Execute("DELETE FROM ".$Tables["Projects"]." WHERE ID = ".$this->ProjectID);

                // Clear cached projects
                ProjectIterator::ClearCache($this->LocaleID);
        }

        /* SET METHODS */

        public function SetName($name)
        {
                if(!$name)
                {
                        throw new Exception("Cannot set Project Name to emtpy.");
                }
                $this->Name = $name;
        }
        
        public function SetSkeleton($skeleton)
        {
                $this->Skeleton = $skeleton;
        }

        public function SetDocument($document)
        {
                $this->Document = $document;
        }


        /* GET METHODS */
        
        public function GetName()
        {
                if(!isset($this->Name))
                {
                        throw new Exception("Uninitialized project, cannot get Name.");
                }
                return $this->Name;
        }
        
        public function GetID()
        {
                if(!isset($this->Name))
                {
                        throw new Exception("Uninitialized project, cannot get ID.");
                }
                return $this->ProjectID;
        }

        public function GetRootID()
        {
                if(!isset($this->Name))
                {
                        throw new Exception("Uninitialized project, cannot get Root ID.");
                }
                return $this->RootID;
        }

        public function GetParentID()
        {
                if(!isset($this->Name))
                {
                        throw new Exception("Uninitialized project, cannot get Parent ID.");
                }
                return $this->ParentID;
        }

        public function GetIsFolder()
        {
                if(!isset($this->Name))
                {
                        throw new Exception("Uninitialized project, cannot get IsFolder.");
                }
                return $this->IsFolder;
        }
        
        public function GetLocaleID()
        {
                if(!isset($this->Name))
                {
                        throw new Exception("Uninitialized project, cannot get Locale ID.");
                }
                return $this->LocaleID;
        }

        public function GetSkeleton()
        {
                if(!isset($this->Name))
                {
                        throw new Exception("Uninitialized project, cannot get Skeleton.");
                }
                return $this->Skeleton;
        }
        
        public function GetDocument()
        {
                if(!isset($this->Name))
                {
                        throw new Exception("Uninitialized project, cannot get Document.");
                }
                return $this->Document;
        }

        public function GetLastSeen()
        {
                if(!isset($this->Name))
                {
                        throw new Exception("Uninitialized project, cannot get LastSeen.");
                }
                return $this->LastSeen;
        }
}

?>