Dataface/Clipboard.php

Go to the documentation of this file.

<?php
import('Dataface/AuthenticationTool.php');
import('Dataface/IO.php');
define('Dataface_Clipboard_tablename', '_df_clipboard');
define('Dataface_Clipboard_lifetime', 1800);
define('Dataface_Clipboard_threshold', 20);
define('Dataface_Clipboard_clipboard_id_key', '_df_clipboard_id');

class Dataface_Clipboard {

        var $id;
        var $errors;
        var $warnings;
        var $messages;
        
        function Dataface_Clipboard($id){
                $this->id = $id;
        }

        function isInstalled(){
                static $isInstalled = -1;
                if ( $isInstalled == -1 ){
                
                        $app =& Dataface_Application::getInstance();
                        $isInstalled = ( mysql_num_rows(mysql_query("show tables like '".Dataface_Clipboard_tablename."'", $app->db())) == 0 );
                }
                return $isInstalled;
        }
        
        function install(){
                if ( !Dataface_Clipboard::isInstalled() ){
                        $app =& Dataface_Application::getInstance();
                        mysql_query(
                                "CREATE TABLE `".Dataface_Clipboard_tablename."` (
                                        `clipid` INT(11) auto_increment NOT NULL,
                                        `clipperid` VARCHAR(32) NOT NULL,
                                        `cut` TINYINT(1) DEFAULT 0,
                                        `recordids` TEXT,
                                        `lastmodified` datetime,
                                        PRIMARY KEY (`clipid`),
                                        UNIQUE (`clipperid`))", $app->db()) or trigger_error("Failed to create clipboard table: ".mysql_error($app->db()), E_USER_ERROR);
                        return true;
                }
                return false;
        
        }
        
        
        function clean(){
                $app =& Dataface_Application::getInstance();
                mysql_query("delete from `".Dataface_Clipboard_tablename."` where UNIX_TIMESTAMP(`lastmodified`) > ".(time()-Dataface_Clipboard_lifetime),
                        $app->db()) or trigger_error("Failed to clean old data from the clipboard: ".mysql_error($app->db()), E_USER_ERROR);
        }
        
        
        function shotgunClean(){
                if ( rand(0,100) > Dataface_Clipboard_threshold ){
                        Dataface_Clipboard::clean();
                }
        }
        
        
        public static function &getInstance(){
                static $clipboard = 0;
                if ( $clipboard == 0 ){
                        // we need to get an id for the clipboard
                        $auth =& Dataface_AuthenticationTool::getInstance();
                        $username = $auth->getLoggedInUsername();
                        if ( isset($username) ) $id = $username;
                        else {
                                if ( @session_id() ){
                                        if ( isset($_SESSION[Dataface_Clipboard_clipboard_id_key]) ){
                                                $id = $_SESSION[Dataface_Clipboard_clipboard_id_key];
                                        } else {
                                                $id = md5(rand(0,10000000));
                                                $_SESSION[Dataface_Clipboard_clipboard_id_key] = $id;
                                        }
                                } else {
                                        $err= PEAR::raiseError("No clipboard is available because the user is not logged in and sessions are not enabled.");
                                        return $err;
                                }
                        }
                
                        $clipboard = new Dataface_Clipboard($id);
                        
                }
                return $clipboard;
        }
        
        function empty(){
                return (mysql_num_rows(mysql_query("select count(*) from `".Dataface_Clipboard_tablename."` where `clipperid`='".addslashes($this->id)."'")) == 0);
        }
        
        
        function copy($recordids){
                $this->clearLogs();
                $app =& Dataface_Application::getInstance();
                Dataface_Clipboard::shotgunClean();
                $res = mysql_query(
                        "REPLACE INTO `".Dataface_Clipboard_tablename."` 
                        (`clipperid`,`cut`,`recordids`,`lastmodified`)
                        VALUES
                        ('".addslashes($this->id)."',
                        0,'".addslashes(implode("\n",$recordids))."', NOW()
                        )", $app->db();
                if ( !$res ){
                        return PEAR::raiseError(mysql_error($app->db()));
                }
                return true;
        
        }
        
        function cut($recordids){
                $this->clearLogs();
                $app =& Dataface_Application::getInstance();
                Dataface_Clipboard::shotgunClean();
                $res = mysql_query(
                        "REPLACE INTO `".Dataface_Clipboard_tablename."` 
                        (`clipperid`,`cut`,`recordids`,`lastmodified`)
                        VALUES
                        ('".addslashes($this->id)."',
                        1,'".addslashes(implode("\n",$recordids))."', NOW()
                        )", $app->db();
                if ( !$res ){
                        return PEAR::raiseError(mysql_error($app->db()));
                }
                return true;
        }
        
        function paste($destid, $relationship=null){
                $this->clearLogs();
                $app =& Dataface_Application::getInstance();
                Dataface_Clipboard::shotgunClean();
                $res = mysql_query("SELECT * FROM `".Dataface_Clipboard_tablename."` where `clipperid`='".addslashes($this->id)."'", $app->db());
                if ( mysql_num_rows($res)>0 ){
                        $row = mysql_fetch_assoc($res);
                } else {
                        return PEAR::raiseError('The clipboard is empty.');
                }
                
                $dest =& Dataface_IO::loadRecordById($destid);
                        // The destination record.
                
                if ( !isset( $dest ) ) return PEAR::raiseError('The destination "'.$destid.'" could not be found to paste the clipboard contents.');
                if ( is_a($dest, 'Dataface_RelatedRecord') ){
                        // we don't paste into related records... so lets turn this into a Dataface_Record object
                        $destrecord =& $dest->toRecord();
                        unset($dest);
                        $dest =& $destrecord;
                        unset($destrecord);
                }
                
                if ( !isset($relationship) ){
                        $rel =& $dest->_table->getChildrenRelationship();
                        if ( !isset($rel) ){
                                return PEAR::raiseError('No relationship was specified into which to paste the contents of the clipboard.');
                        } else {
                                $relationship = $rel->getName();
                                unset($rel);
                        }
                }
                
                $io = new Dataface_IO($dest->_table->tablename);
                
                // $row should now contain the clipboard contents.
                $recordids = explode("\n", $row['recordids']);
                foreach ( $recordids as $recordid ){
                        $record =& Dataface_IO::loadRecordById($recordid);
                        if ( is_a($record, 'Dataface_Record')){
                                $io2 = new Dataface_IO($record->_table->tablename);
                        } else {
                                $io2 = new Dataface_IO($record->_record->_table);
                        }
                        
                        if ( isset($record) and !PEAR::isError($record) ){
                                // the record id was loaded successfully
                                $newrecord = new Dataface_RelatedRecord($dest, $relationship, $record->vals());
                                $io->addExistingRelatedRecord($newrecord);
                                
                                if ( $row['cut'] ){
                                        // This was cut from the clipboard so we need to remove the original
                                        $res = $io2->removeRelatedRecord($record, false);
                                        if ( PEAR::isError($res) ){
                                                if ( Dataface_Error::isWarning($res) ) $this->logWarning($res);
                                                else $this->logError($res);
                                        }
                                }
                        }
                        
                        unset($record);
                        unset($newrecord);
                        unset($io2);
                }
                
                
        }
        

        
        function logError($error){
                $this->errors[] = $error;
        }
        
        function logWarning($warning){
                $this->warnings[] = $warning;
        }
        
        function logMessage($message){
                $this->messages[] = $message;
        }
        
        function clearLogs(){
                $this->errors = array();
                $this->warnings = array();
                $this->messages = array();
        }

}