/Applications/XAMPP/xamppfiles/htdocs/recipedb/modules/tm/lib/XFTranslationMemory.php

Go to the documentation of this file.

<?php
/*
 * Xataface Translation Memory Module
 * Copyright (C) 2011  Steve Hannah <steve@weblite.ca>
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 * 
 * This library 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
 * Library General Public License for more details.
 * 
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
 * Boston, MA  02110-1301, USA.
 *
 */
require_once(dirname(__FILE__).DIRECTORY_SEPARATOR.'TMTools.php');

class XFTranslationMemory {

        const TRANSLATION_REJECTED=1;
        //const TRANSLATION_VOTE_DOWN=2;
        const TRANSLATION_SUBMITTED=3;
        //const TRANSLATION_VOTE_UP=4;
        const TRANSLATION_APPROVED=5;

        private $_rec;
        

        public function __construct(Dataface_Record $rec){
                $this->_rec = $rec;
        }
        
        public function getRecord(){
                return $this->_rec;
        }
        
        public function getSourceLanguage(){
                return $this->_rec->val('source_language');
        }
        
        
        public function getDestinationLanguage(){
                return $this->_rec->val('destination_language');
        }

        
        private static $defaultTranslationMemories = null;
        
        
        public static function getDefaultTranslationMemory($source, $dest, $secure=false){
                $source = strtolower($source);
                $dest = strtolower($dest);
                if ( !isset(self::$defaultTranslationMemories) ){
                        self::$defaultTranslationMemories = array();
                }
                
                if ( !isset(self::$defaultTranslationMemories[$source]) ){
                        self::$defaultTranslationMemories[$source] = array();
                }
                
                if ( !isset(self::$defaultTranslationMemories[$source][$dest]) ){
                        $rec = df_get_record('xf_tm_records',
                                array(
                                        'record_id'=>'=*',
                                        'source_language'=>'='.$source,
                                        'destination_language'=>'='.$dest
                                )
                        );
                        
                        if ( $rec ){
                        
                                self::$defaultTranslationMemories[$source][$dest] = self::loadTranslationMemoryById($rec->val('translation_memory_id'));
                                
                        }
                }
                
                if ( !isset(self::$defaultTranslationMemories[$source][$dest]) ){
                        $tm = self::createTranslationMemory('Default '.$source.'=>'.$dest, $source, $dest, $secure);
                        $tm->assignTo('*');
                        self::$defaultTranslationMemories[$source][$dest] = $tm;
                }
                return self::$defaultTranslationMemories[$source][$dest];
        }
        
        private static function createTranslationMemory($name, $source, $dest, $secure=false){
                $source = strtolower($source); $dest = strtolower($dest);
                if ( !preg_match('/^[a-z0-9]{2}$/', $source) ){
                        throw new Exception("Invalid source language code inserting a translation memory: $source");
                }
                if ( !preg_match('/^[a-z0-9]{2}$/', $dest) ){
                        throw new Exception("Invalid destination language code inserting a translation memory: $dest");
                }
                
                $rec = new Dataface_Record('xf_tm_translation_memories',array());
                $rec->setValues(array(
                        'translation_memory_name'=>$name,
                        'source_language'=>$source,
                        'destination_language'=>$dest
                ));
                $res = $rec->save($secure);
                if ( PEAR::isError($res) ){
                        throw new Exception("Failed to create translation memory ".$res->getMessage(), $res->getCode());
                }
                
                $tm = new XFTranslationMemory($rec);
                
                return $tm;     
        }
        
        
        
        public function assignTo($recid, $secure = false){
                $rec = new Dataface_Record('xf_tm_records', array());
                $rec->setValues(array(
                        'record_id'=>$recid,
                        'translation_memory_id'=>$this->_rec->val('translation_memory_id')
                ));
                $res = $rec->save($secure);
                if ( PEAR::isError($res) ){
                        throw new Exception("Failed to assign the translation memory to the record with id ".$recid);
                        
                }
                
        }

        public static function loadTranslationMemoryById($id){
                $tmrec  = df_get_record('xf_tm_translation_memories', array('translation_memory_id'=>'='.$id));
                if ( !$tmrec ) return null;
                return new XFTranslationMemory($tmrec);
        }


        public static function loadTranslationMemoryFor(Dataface_Record $record, $source, $dest){
                $rec = df_get_record('xf_tm_records', 
                        array(
                                'record_id'=>'='.$record->getId(),
                                'source_language'=>'='.$source,
                                'destination_language'=>'='.$dest
                        )
                );
                if ( !$rec ){
                        return self::getDefaultTranslationMemory($source, $dest);
                }
                
                if ( !$rec->val('translation_memory_id') ){
                        return null;
                }
                
                return self::loadTranslationMemoryById($rec->val('translation_memory_id'));
        }
        
        public function addTranslation($string, $translation, $username=null, $secure=false){
                if ( !$username ) $username = Dataface_AuthenticationTool::getInstance()->getLoggedInUserName();
                $strid = null;
                if ( is_int($string) ){
                        $strid = $string;
                }
                
                if ( !$strid ){
                        $strRec = self::findString($string, $this->getSourceLanguage());
                        if ( !$strRec ){
                                $strRec = self::addString($string, $this->getSourceLanguage(), $secure);
                                
                        }
                        if ( !$strRec ){
                                throw new Exception("Failed to add string $string");
                        }
                        $strid = intval($strRec->val('string_id'));
                        
                }
                
                
                $trec = $this->findTranslation($strid, $translation);
                if ( !$trec ){
                        
                        $normalized = TMTools::normalize($translation);
                        $hash = md5($normalized);
                        $trec = new Dataface_Record('xf_tm_translations', array());
                        $trec->setValues(array(
                                'string_id'=>$strid,
                                'translation_value'=>$translation,
                                'normalized_translation_value'=> $normalized,
                                'language'=> $this->getDestinationLanguage(),
                                'translation_hash'=>$hash,
                                'created_by' => $username
                        ));
                        $res = $trec->save($secure);
                        if ( PEAR::isError($res) ){
                                throw new Exception('Failed to add translation "$translation": '.$res->getMessage(), $res->getCode());
                        }
                }
                
                // Now add this translation to the translation memory
                $res = mysql_query("insert ignore into xf_tm_translation_memory_translations 
                        (translation_memory_id,translation_id)
                        values
                        ('".addslashes($this->_rec->val('translation_memory_id'))."',
                         '".addslashes($trec->val('translation_id'))."'
                         )", df_db());
                if ( !$res ) throw new Exception(mysql_error(df_db()));
                
                
                return $trec;
                        
                
                
                
        }
        
        public function containsTranslation($string, $translation){
                $tr = $this->findTranslation($string, $translation);
                if ( !$tr ) return false;
                $tm = df_get_record('xf_tm_translation_memory_translations', 
                        array(
                                'translation_memory_id'=>'='.$this->_rec->val('translation_memory_id'),
                                'translation_id'=>'='.$tr->val('translation_id')
                        )
                );
                if ( !$tm ) return false;
                else return true;
        }
        
        
        public static function findString($string, $language){
                $normalized = TMTools::normalize($string);
                $hash = md5($normalized);
                $strRec = df_get_record('xf_tm_strings', 
                        array(
                                'normalized_value'=>'='.$normalized, 
                                'hash'=>'='.$hash,
                                'language'=>'='.$language));
                if ( !$strRec ) return null;
                return $strRec;
        }
        
        
        public static function addString($string, $language, $secure=false){
                
                $str = self::findString($string, $language);
                if ( !$str ){
                        $app = Dataface_Application::getInstance();
                        $strRec = new Dataface_Record('xf_tm_strings', array());
                        $normalized = TMTools::normalize($string);
                        $hash = md5($normalized);
                        $strRec->setValues(array(
                                'language'=>$language,
                                'string_value'=>$string,
                                'normalized_value'=>$normalized,
                                'hash'=> $hash
                        ));
                        $res = $strRec->save($secure);
                        if ( PEAR::isError($res) ){
                                
                                throw new Exception($res->getMessage());
                        }
                        return $strRec;
                                
                }
                return $str;
        }
        
        
        public function findTranslation($string, $translation){
                $strid = null;
                if ( is_int($string) ) $strid = $string;
                
                if ( !$strid ){
                        
                        $strRec = self::findString($string, $this->getSourceLanguage());
                        if ( $strRec ){
                                $strid = intval($strRec->val('string_id'));
                        }
                        
                }
                if ( !$strid ) return null;
                
                $normalizedTranslation = TMTools::normalize($translation);
                $hashTranslation = md5($normalizedTranslation);
                
                $trRec = df_get_record('xf_tm_translations', 
                        array(
                                'string_id'=>'='.$strid,
                                'normalized_translation_value'=>'='.$normalizedTranslation,
                                'translation_hash'=>'='.$hashTranslation,
                                'language'=>'='.$this->getDestinationLanguage()
                                
                        )
                );
                
                if ( !$trRec ) return null;
                
                return $trRec;
                
                
        }
        
        public function scoreTranslation($string, $translation, $score, $username=null, $secure=false){
                
                if ( !$username ) $username = Dataface_AuthenticationTool::getInstance()->getLoggedInUserName();
                $trec = $this->findTranslation($string, $translation);
                
                if ( !$trec ){
                        $trec = $this->addTranslation($string, $translation, $username, $secure);
                }
                
                if ( !$trec ){
                        throw new Exception("Could not find matching translation and failed to add one.");
                }
                
                $arec = new Dataface_Record('xf_tm_translations_score', array());
                $arec->setValues(array(
                        'translation_id'=>$trec->val('translation_id'),
                        'translation_memory_id'=>$this->_rec->val('translation_memory_id'),
                        'username'=>$username,
                        'score'=>$score
                ));
                $res = $arec->save($secure);
                if ( PEAR::isError($res) ){
                        throw new Exception("Failed to approve translation: ".$res->getMessage());
                        
                }
                return $arec;
                
        }
        
        
        public function setTranslationStatus($string, $translation, $status, $username=null, $secure=false){
                if ( !$username ) $username = Dataface_AuthenticationTool::getInstance()->getLoggedInUserName();
                $trec = $this->findTranslation($string, $translation);
                
                if ( !$trec ){
                        $trec = $this->addTranslation($string, $translation, $username, $secure);
                }
                
                if ( !$trec ){
                        throw new Exception("Could not find matching translation and failed to add one.");
                }
                
                $arec = new Dataface_Record('xf_tm_translations_status', array());
                $arec->setValues(array(
                        'translation_id'=>$trec->val('translation_id'),
                        'translation_memory_id'=>$this->_rec->val('translation_memory_id'),
                        'username'=>$username,
                        'status_id'=>$status
                ));
                $res = $arec->save($secure);
                if ( PEAR::isError($res) ){
                        throw new Exception("Failed to approve translation: ".$res->getMessage());
                        
                }
                return $arec;
        }
        
        
        public function addTranslationComment($string, $translation, $comment, $username=null, $secure=false){
                if ( !$username ) $username = Dataface_AuthenticationTool::getInstance()->getLoggedInUserName();
                $trec = $this->findTranslation($string, $translation);
                
                if ( !$trec ){
                        $trec = $this->addTranslation($string, $translation, $username, $secure);
                }
                
                if ( !$trec ){
                        throw new Exception("Could not find matching translation and failed to add one.");
                }
                
                $arec = new Dataface_Record('xf_tm_translations_comments', array());
                $arec->setValues(array(
                        'translation_id'=>$trec->val('translation_id'),
                        'translation_memory_id'=>$this->_rec->val('translation_memory_id'),
                        'posted_by'=>$username,
                        'comments'=>$comment
                ));
                $res = $arec->save($secure);
                if ( PEAR::isError($res) ){
                        throw new Exception("Failed to approve translation: ".$res->getMessage());
                        
                }
                return $arec;
        }
        
        public function getTranslations(array $sources, $minStatus=3, $maxStatus=5){
                $out = array();
                $normalized = array();
                $hashed = array();
                $hashIndex = array();
                $disqualified = array();
                foreach ($sources as $k=>$src){
                        $normalized[$k] = TMTools::normalize($src);
                        $hashed[$k] = md5($normalized[$k]);
                        $hashIndex[$hashed[$k]] = $k;
                        $out[$k] = null;
                }
                
                $hashesStr = "'".implode("','", $hashed)."'";
                if ( !$hashesStr ) $hashesStr = '0';
                $hashesStr = '('.$hashesStr.')';
                
                
                $sql = "select 
                        s.`hash`,
                        t.translation_value,
                        tts.status_id
                        from 
                                xf_tm_translations t
                                inner join xf_tm_translations_status tts on t.translation_id=tts.translation_id and tts.translation_memory_id='".addslashes($this->_rec->val('translation_memory_id'))."'
                                inner join xf_tm_strings s on t.string_id=s.string_id
                        where 
                                tts.translation_memory_id='".addslashes($this->_rec->val('translation_memory_id'))."'
                                and s.`hash` in $hashesStr
                                
                        order by tts.date_created desc";
                $res  = mysql_query($sql, df_db());
                if ( !$res ) throw new Exception(mysql_error(df_db()));
                
                while ($row = mysql_fetch_assoc($res) ){
                        $k = $hashIndex[$row['hash']];
                        if ( !isset($k) ){
                                throw new Exception("Invalid hash returned");
                        }
                        if ( !isset($out[$k]) ){
                                if ( $row['status_id'] < $minStatus or $row['status_id'] > $maxStatus ){
                                        $disqualified[$k] = true;
                                } else if ( !@$disqualified[$k] ){
                                        $out[$k] = $row['translation_value'];
                                }
                        }
                }
                @mysql_free_result($res);
                return $out;
                
                        
                        
        }
        
        
        
}