class.MergingPlugin.php

<?php
require_once (INCLUDE_DIR . 'class.signal.php');
require_once (INCLUDE_DIR . 'class.ticket.php');
require_once ('config.php');

define('TICKET_RELATION_TABLE', TABLE_PREFIX . 'ticket_relation');

class MergingPlugin extends Plugin {
    
    const DEBUG = FALSE;
    /**
     * Which config to use (in config.php)
     *
     * @var string
     */
    public $config_class = 'MergingPluginConfig';
    
    /**
     * Run on every instantiation of osTicket..
     * needs to be concise
     *
     * {@inheritdoc}
     *
     * @see Plugin::bootstrap()
     */
    function bootstrap() {
        if($this->firstRun()){
            if (! $this->configureFirstRun ()) {
                return false;
            }
        }
        ob_start();
        register_shutdown_function(function () {
            global $thisstaff;
            $html = ob_get_clean();
            $ticket = null;
            if($thisstaff){
                if($_REQUEST['id'] && ($ticket=Ticket::lookup($_REQUEST['id']))){
                    $html = $this->addContentBefore($html,
                        '/<a.*?href="#post-reply"(.|\n)*?<\/a>/',
                        $this->getActions($thisstaff, $ticket));
                    if($this->isChild($ticket) || $this->isMaster($ticket)){
                        $html = $this->addContentAfter($html,
                            '/<ul.*?class="tabs"(.|\n)*?(?=<\/ul>)/',
                            '<li><a id="ticket-thread-tab" href="#relations">' .
                            __('Relations') . '</a></li>');
                        $html = preg_replace('/(?<=' . $ticket->getSubject() . ').*?(?=<\/h3>)/',
                            ' - ' . ($this->isMaster($ticket) ? __('MASTER') : __('CHILD')), $html);
                        $html = $this->addContentBefore($html,
                            '/(<\/div>(\s|\n)*){3}<div.*id="print-options">/',
                            $this->getRelationsTab($ticket));
                    }
                } else if(strpos($_SERVER['REQUEST_URI'], "tickets.php")){
                    $html = $this->addContentAfter($html,
                        '/<div class="pull-right flush-right">/',
                        $this->getActions($thisstaff));
                }
                    $html = str_replace("{MERGING_INSTALL_PATH}", self::getInstallPath(), $html);
            }
            print $html;
        });
    }
    
    function firstRun() {
        $sql = 'SHOW TABLES LIKE \'' . TICKET_RELATION_TABLE . '\'';
        $res = db_query ( $sql );
        return (db_num_rows ( $res ) == 0);
    }
    
    function configureFirstRun() {
        if (! $this->insertSql ()) {
            echo "First run configuration error.  " . "Unable to create database tables!";
            return false;
        }
        return true;
    }
    
    function insertSql(){
        $result = false;
        $sql = "CREATE TABLE IF NOT EXISTS `" . TICKET_RELATION_TABLE . "` (
            `id` int(11) unsigned NOT NULL AUTO_INCREMENT,
            `agent_id` int(11) NOT NULL,
            `master_id` int(11) NOT NULL,
            `ticket_id` int(11) NOT NULL,
            `date_merged` datetime NOT NULL,
            PRIMARY KEY (`id`)
        );";
        $result = db_query($sql);
        if(!$result)
            return $result;
        $sql = "ALTER TABLE `" . THREAD_EVENT_TABLE . "` CHANGE `state` `state` ENUM('created','closed','reopened',
            'assigned','transferred','overdue','edited','viewed','error','collab','resent','merged',
            'split') CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL;";
        return db_query($sql);
    }
    
    function addContentBefore($html, $regex, $content){
        if(preg_match($regex, $html, $match))
            return str_replace($match[0], $content . $match[0], $html);
        return $html;
    }
    
    function addContentAfter($html, $regex, $content){
        if(preg_match($regex, $html, $match))
            return str_replace($match[0], $match[0] . $content, $html);
        return $html;
    }
    
    function getActions($staff, $ticket=null){
        $result = '';
        if($ticket)
            $result = file_get_contents(__DIR__ . '/templates/merge-view.php');
        else
            $result = file_get_contents(__DIR__ . '/templates/merge.php');
        $tickets = TicketModel::objects();

        // -- Open and assigned to me
        $assigned = Q::any(array(
            'staff_id' => $staff->getId(),
        ));
        // -- Open and assigned to a team of mine
        if ($teams = array_filter($staff->getTeams()))
            $assigned->add(array('team_id__in' => $teams));
        $visibility = Q::any(new Q(array('status__state'=>'open', $assigned)));
        // -- Routed to a department of mine
        if (!$staff->showAssignedOnly() && ($depts=$staff->getDepts()))
            $visibility->add(array('dept_id__in' => $depts));
        $tickets->filter(Q::any($visibility));

        $tickets->filter(array('status__state'=>'open'));
        $tickets->values('ticket_id', 'number', 'cdata__subject');

        $options = '';
        foreach ($tickets as $T)
            $options = $options . "<option value='" . $T['ticket_id'] . "'>" . $T['number'] . " | " . $T['cdata__subject'] . "</option>";
        $result = str_replace("{MERGING_OPTIONS}", $options, $result);
        $result = str_replace("{MERGING_TOOLTIP}", __('Merge'), $result);
        $result = str_replace("{MERGING_PLACEHOLDER}", __('Select a ticket'), $result);
        if($ticket)
            $result = str_replace("{MERGING_TICKET_ID}", $ticket->getId(), $result);
        return $result;
    }
    
    function getRelationsTab($ticket){
        $result = $this->isMaster($ticket) ? $this->getMasterRelationsTab($ticket) 
            : $this->getChildRelationsTab($ticket);
        $result = str_replace("{MERGING_TRANSLATE_NUMBER}", __('Number'), $result);
        $result = str_replace("{MERGING_TRANSLATE_PRIORITY}", __('Priority'), $result);
        $result = str_replace("{MERGING_TRANSLATE_DEPARTMENT}", __('Department'), $result);
        $result = str_replace("{MERGING_TRANSLATE_SUBJECT}", __('Subject'), $result);
        $result = str_replace("{MERGING_TRANSLATE_DATE_MERGED}", __('Date merged'), $result);
        $result = str_replace("{MERGING_TRANSLATE_FROM}", __('From'), $result);
        $result = str_replace("{MERGING_TRANSLATE_CLOSED_BY}", __('Closed by'), $result);
        return $result;
    }
    
    function getMasterRelationsTab($ticket){
        $result = file_get_contents(__DIR__ . '/templates/relationstab-master.php');
        $childcontent = '';
        $children = $this->getChildren($ticket);
        foreach ($children as $T) {
            $childcontent = $childcontent . '<tr id="' . $T->getId() . '">
                <td nowrap>
                    <a class="Icon ' . strtolower($T->getSource()) . 'Ticket preview"
                    title="Preview Ticket"
                    href="tickets.php?id=' . $T->getId() . '"
                    data-preview="#tickets/' . $T->getId() . '/preview"
                    >' . $T->getNumber() . '</a>
                </td>
                <td align="center" nowrap>' . (Format::datetime($this->getDateMerged($T)) ?: $date_fallback) . '</td>
                <td>
                    <div style="max-width: 279px; max-height: 1.2em"
                    class="link truncate"
                    href="tickets.php?id=' . $T->getId() . '">' . $T->getSubject() . '</div>
                </td>
                <td nowrap>
                    <div>
                        <span class="truncate">' . Format::htmlchars($T->getDeptName()) . '</span>
                    </div>
                </td>
                <td nowrap>
                    <div>
                        <span class="truncate">' . (Format::htmlchars($T->getStaff() ? $T->getStaff()->getName() : __('Unknown'))) . '</span>
                    </div>
                </td>
                <td nowrap>
                    <div data-toggle="tooltip" title="' . __('Split') . '" style="height: 26px;">
                        <button type="submit" class="action-button" onclick="$.ajax({
                            type: \'POST\',
                            url: \'../include/{MERGING_INSTALL_PATH}/ajax.php\',
                            data: ({master: ' . $ticket->getId() . ',ticket: ' . $T->getId() . ',a: \'split\'}),
                            success: function(data) {
                            location.reload();
                            }
                            });">
                            <i class="icon-trash"></i>
                        </button>
                    </div>
                </td>
            </tr>';
        }
        $result = str_replace("{MERGING_CHILD_TICKETS}", $childcontent, $result);
        $result = str_replace("{MERGING_TRANSLATE_CHILD_TICKETS}", __('Child tickets'), $result);
        return $result;
    }
    
    function getChildRelationsTab($ticket){
        $result = file_get_contents(__DIR__ . '/templates/relationstab-child.php');
        $master = $this->getMaster($ticket);
        $result = str_replace("{MERGING_ID}", $master->getId(), $result);
        $result = str_replace("{MERGING_SOURCE}", strtolower($master->getSource()), $result);
        $result = str_replace("{MERGING_NUMBER}", $master->getNumber(), $result);
        $result = str_replace("{MERGING_PRIORITY}", $master->getPriority(), $result);
        $result = str_replace("{MERGING_DEPARTMENT}", $master->getDeptName(), $result);
        $result = str_replace("{MERGING_SUBJECT}", $master->getSubject(), $result);
        $result = str_replace("{MERGING_DATE_MERGED}", $this->getDateMerged($ticket), $result);
        $result = str_replace("{MERGING_TRANSLATE_MASTER_TICKET}", __('Master ticket'), $result);
        return $result;
    }
    
    function merge($master, $tids){
        global $thisstaff;
        $mergingplugin = new MergingPlugin;
        $config = $mergingplugin->getConfig();
        
        if(!self::canBeMaster($master)){
            Messages::error(__('Ticket selected for master cannot be one.'));
            return false;
        }
        
        $tickets = array();
        foreach(explode(',', $tids) as $tid){
            //Master ticket can't be child ticket aswell.
            if($tid == $master->getId())
                continue;
            //Proper ID?
            $temp = Ticket::lookup($tid);
            if(!$temp)
                continue;
            if(!self::canBeChild($temp)){
                Messages::warning(sprintf(__('Ticket #%s cannot be a child.'), $temp->getNumber()));
                continue;
            }
            if(!$temp->isCloseable()){
                Messages::warning(sprintf(__('Ticket #%s cannot be closed.'), $temp->getNumber()));
                continue;
            }
            $tickets[] = $temp;
        }
        
        unset($temp);
        
        if(empty($tickets)){
            Messages::error(__('Select at least one viable ticket'));
            return false;
        }
        
        foreach($tickets as $temp){
            $temp->setStatus(TicketStatus::lookup($config->get('childstatus')));
            
            if($config->get('copyrecipients')){
                $master->addCollaborator($temp->getUser(), array(), $error, true);
                if ($collabs = $temp->getThread()->getParticipants()) {
                    foreach ($collabs as $c)
                        $master->addCollaborator($c->getUser(), array(), $error, true);
                }
            }
            
            $sql='INSERT INTO '.TICKET_RELATION_TABLE.' (`id`, `agent_id`, `master_id`, `ticket_id`, `date_merged`)
                VALUES(NULL, '.$thisstaff->getId().', '.$master->getId().', '.$temp->getId().', NOW())';
            db_query($sql);
            self::setChild($temp, true);
            $master->logEvent('merged', array('child' => $temp->getSubject(), 'id' => $temp->getId()));
        }
        self::setMaster($master, true);
        return true;
    }
    
    function split($master, $tid){
        if($tid == $master->getId())
            return false;
        
        $ticket = Ticket::lookup($tid);
        if(!$ticket || !self::isChild($ticket))
            return false;
        
        $sql='DELETE FROM '.TICKET_RELATION_TABLE.' WHERE master_id = ' . $master->getId() . ' AND ticket_id = ' . $tid;
        db_query($sql);
        self::setChild($ticket, false);
        
        if(!self::getChildren($master))
            self::setMaster($master, false);
        
        $master->logEvent('split', array('child' => $ticket->getSubject(), 'id' => $tid));
        return true;
    }
    
    function massSplit($tids){
        global $thisstaff;
        
        foreach($tids as $key => $tid){
            if(!($temp = Ticket::lookup($tid)))
                continue;
            if(self::isMaster($temp))
                foreach(self::getChildren($temp) as $ticket)
                    self::split($temp, $ticket->getId());
            else if(self::isChild($temp))
                self::split(self::getMaster($temp), $tid);
            else
                Messages::warning(sprintf(__('Ticket #%s is not merged.'), $temp->getNumber()));
        }
        return true;
    }
    
    function isMaster($ticket){
        if(!isset($ticket->master)){
            $sql='SELECT ticket_id FROM '.TICKET_RELATION_TABLE.' WHERE master_id = ' . $ticket->getId();
            if($res=db_query($sql))
                self::setMaster($ticket, db_num_rows($res));
        }
        return $ticket->master;
    }
    
    function canBeMaster($ticket){
        if(self::isMaster($ticket))
            return true;
        if(self::isChild($ticket))
            return false;
        return true;
    }
    
    function isChild($ticket){
        if(!isset($ticket->child)){
            $sql='SELECT ticket_id, date_merged FROM '.TICKET_RELATION_TABLE.' WHERE ticket_id = ' . $ticket->getId();
            
            if($res=db_query($sql)){
                $nr = db_num_rows($res);
                self::setChild($ticket, $nr);
                if($nr){
                    list($tid, $datem) = db_fetch_row($res);
                    self::setDateMerged($ticket, $datem);
                }
            }
        }
        return $ticket->child;
    }
    
    function canBeChild($ticket){
        return !self::isMaster($ticket) && !self::isChild($ticket);
    }
    
    function setMaster($ticket, $var){
        $ticket->master = (boolean)$var;
    }
    
    function setChild($ticket, $var){
        $ticket->child = (boolean)$var;
    }
    
    function getDateMerged($ticket){
        return (!self::isChild($ticket) || !isset($ticket->dateMerged)) ? false : $ticket->dateMerged;
    }
    
    function setDateMerged($ticket, $date){
        $ticket->dateMerged = $date;
    }
    
    function getChildren($ticket){
        if(!self::isMaster($ticket))
            return array();
        
        $sql='SELECT ticket_id, date_merged FROM '.TICKET_RELATION_TABLE.' WHERE master_id = ' . $ticket->getId();
        
        $ret = array();
        if(($res=db_query($sql)) && db_num_rows($res))
            while(list($id, $tmpdate)=db_fetch_row($res))
                if($temp=Ticket::lookup($id)){
                    self::setDateMerged($temp, $tmpdate);
                    self::setChild($temp, true);
                    $ret[] = $temp;
                }
        return $ret;
    }
    
    function getMaster($ticket){
        if(!self::isChild($ticket))
            return array();
        
        $sql='SELECT master_id FROM '.TICKET_RELATION_TABLE.' WHERE ticket_id = ' . $ticket->getId();
        if(($res=db_query($sql)) && db_num_rows($res)) {
            list($id)=db_fetch_row($res);
            if ($temp=Ticket::lookup($id)) {
                self::setMaster($temp, true);
                return $temp;
            }
        }
        return false;
    }
    
    /**
     * Required stub.
     *
     * {@inheritdoc}
     *
     * @see Plugin::uninstall()
     */
    function uninstall() {
        $errors = array ();
        $result = false;
        $sql = "DROP TABLE IF EXISTS `" . TICKET_RELATION_TABLE . "`;";
        db_query($sql);
        $sql = "ALTER TABLE `" . THREAD_EVENT_TABLE . "` CHANGE `state` `state` ENUM('created','closed','reopened',
            'assigned','transferred','overdue','edited','viewed','error','collab','resent'
            ) CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL;";
        db_query($sql);
        parent::uninstall ( $errors );
    }
    
    /**
     * Plugins seem to want this.
     */
    public function getForm() {
        return array ();
    }
}

class MergedEvent extends ThreadEvent {
    static $icon = 'code-fork';
    static $state = 'merged';
    function getDescription($mode=self::MODE_STAFF) {
        return sprintf($this->template(__('<b>{somebody}</b> merged this ticket with %s{data.id}%s<b>{data.child}</b>%s {timestamp}')),
                '<a href="/scp/tickets.php?id=', '">', '</a>');
    }
}
class SplitEvent extends ThreadEvent {
    static $icon = 'share-alt';
    static $state = 'split';
    function getDescription($mode=self::MODE_STAFF) {
        return sprintf($this->template(__('<b>{somebody}</b> split this ticket from %s{data.id}%s<b>{data.child}</b>%s {timestamp}')),
                '<a href="/scp/tickets.php?id=', '">', '</a>');
    }
}