Handler.php

<?php
/**
 * Defines the AJAX actions used in Hermes.
 *
 * Copyright 2012-2013 Horde LLC (http://www.horde.org/)
 *
 * See the enclosed file COPYING for license information (GPL). If you
 * did not receive this file, see http://www.horde.org/licenses/gpl.
 *
 * @author   Michael J Rubinsky <mrubinsk@horde.org>
 * @category Horde
 * @license  http://www.horde.org/licenses/gpl GPL
 * @package  Hermes
 */
class Hermes_Ajax_Application_Handler extends Horde_Core_Ajax_Application_Handler
{
    /**
     * Add a new timer.  Expects the following in $this->vars:
     *   - desc:  The timer description.
     *   - client_id:
     *   - deliverable_id:
     *   - jobtype_id:
     *
     * @return array  An array with an 'id' key.
     */
    public function addTimer()
    {
        $id = Hermes::newTimer($this->vars->desc, $this->vars);
        $timer = Hermes::getTimer($id);

        return $timer;
    }

    /**
     * Create a new jobtype. Takes the following from $this->vars:
     *   - name:     (string)  They type name.
     *   - billable: (boolean) Is this type billable?
     *   - enabled:  (boolean) Is this type enabled?
     *   - rate:     (double)  The default hourly rate to use for this type.
     *
     * @return integer  The type id of the newly created type.
     */
    public function createJobType()
    {
        $job = array(
            'id' => 0,
            'name' => $this->vars->name,
            'billable' => $this->vars->billable == 'on',
            'enabled' => $this->vars->enabled == 'on',
            'rate' => $this->vars->rate);
        try {
            $id = $GLOBALS['injector']
                ->getInstance('Hermes_Driver')
                ->updateJobType($job);
            $GLOBALS['notification']->push(_("Job type successfully added."), 'horde.success');
        } catch (Hermes_Exception $e) {
            $GLOBALS['notification']->push($e->getMessage(), 'horde.error');
        }

        return $id;
    }

    /**
     * Create a new deliverable. Takes the following in $this->vars:
     *   - deliverable_id:      The id of the deliverable if editing.
     *   - name:   (string)     The deliverable name.
     *   - active: (boolean)    Is the deliverable active?
     *   - estimate: (integer)  The estimate for this deliverable.
     *   - desc: (string)       The description.
     *   - client_id: (string)     The client id this deliverable is for.
     */
    public function updateDeliverable()
    {
        // Only local Hermes deliverables are editable.
        $deliverable_id = str_replace('hermes:', '', $this->vars->deliverable_id);

        $deliverable = array(
            'id' => empty($this->vars->deliverable_id) ? 0 : $deliverable_id,
            'name' => $this->vars->name,
            'active' => $this->vars->active == 'on',
            'estimate' => $this->vars->estimate,
            'description' => $this->vars->desc,
            'client_id' => $this->vars->client_id);

        try {
            $result = $GLOBALS['injector']
                ->getInstance('Hermes_Driver')
                ->updateDeliverable($deliverable);

            $GLOBALS['notification']->push(_("Deliverable successfully added."), 'horde.success');
            return $result;
        } catch (Hermes_Exception $e) {
            $GLOBALS['notification']->push($e->getMessage(), 'horde.error');
        }
    }

    public function deleteDeliverable()
    {
        // Only local Hermes deliverables are editable.
        $deliverable_id = str_replace('hermes:', '', $this->vars->deliverable_id);
        try {
            $GLOBALS['injector']
                ->getInstance('Hermes_Driver')
                ->deleteDeliverable($deliverable_id);
            $GLOBALS['notification']->push(_("Deliverable successfully deleted."), 'horde.success');
            return true;
        } catch (Hermes_Exception $e) {
            $GLOBALS['notification']->push($e->getMessage(), 'horde.error');
        }
    }

    /**
     * Delete a jobtype. Takes the following in $this->vars:
     *   - id:  The jobtype id to delete.
     *
     */
    public function deleteJobType()
    {
        try {
            $GLOBALS['injector']->getInstance('Hermes_Driver')
                ->deleteJobType($this->vars->id);
            $GLOBALS['notification']->push(_("Job type successfully deleted."), 'horde.success');
            return true;
        } catch (Hermes_Exception $e) {
            $GLOBALS['notification']->push($e->getMessage(), 'horde.error');
        }
    }

    /**
     * Remove a slice. Expects the following in $this->vars:
     *   - id:  The slice id
     *
     * @return boolean
     */
    public function deleteSlice()
    {
        $sid = array('id' => $this->vars->id, 'delete' => true);
        try {
            $result = $GLOBALS['injector']
                ->getInstance('Hermes_Driver')
                ->updateTime(array($sid));
            $GLOBALS['notification']->push(
                _("Your time entry was successfully deleted."), 'horde.success');

            return $result;
        } catch (Hermes_Exception $e) {
            $GLOBALS['notification']->push($e, 'horde.error');
        }
    }

    /**
     * Enter a new time slice. @see Hermes_Slice::readForm for the data expected
     * to be sent in the posted form.
     *
     * @return array  The new timeslice
     */
    public function enterTime()
    {
        $slice = new Hermes_Slice();
        $slice->readForm();

        try {
            $id = $GLOBALS['injector']
                ->getInstance('Hermes_Driver')
                ->enterTime($slice['employee'], $slice);
            $new = $GLOBALS['injector']
                ->getInstance('Hermes_Driver')
                ->getHours(array('id' => $id));

            if ($slice['employee'] == $GLOBALS['registry']->getAuth()) {
                $GLOBALS['notification']
                    ->push(_("Your time was successfully entered."), 'horde.success');

                return current($new)->toJson();
            } else {
                $GLOBALS['notification']
                    ->push(sprintf(_("The time was successfully entered for %s."), $slice['employee']), 'horde.success');
                return true;
            }
        } catch (Hermes_Exception $e) {
            $GLOBALS['notification']->push($e, 'horde.error');
        }
    }

    /**
     * Get a list of client deliverables suitable for building a select list.
     * Expects the following in $this->vars:
     *   - c: The client id, or an array of client ids if querying for specific
     *        clients. Returns all deliverables otherwise.
     *
     * @return array @see Hermes::getCostObjectType
     */
    public function listDeliverablesSelect()
    {
        $client = !empty($this->vars->c) ? $this->vars->c : null;

        return Hermes::getCostObjectType($client);
    }

    /**
     * Get the list of Hermes-only deliverables for the requested client.
     *  - c:   The client id
     *  - id:  The optional deliverable id, if requesting a specific deliverable.
     */
    public function listDeliverables()
    {
        global $injector;

        if (!empty($this->vars->id)) {
            $params = array('id' => $this->vars->id);
            return array_values($injector->getInstance('Hermes_Driver')->listDeliverables($params));
        }

        // Only poll Hermes' deliverables if we have a client id since they
        // are ALWAYS tied to a client. Otherwise, just return the list of
        // external cost objects.
        $client_id = !empty($this->vars->c) ? $this->vars->c : null;
        if (!empty($client_id)) {
            $objs = array_values($injector->getInstance('Hermes_Driver')
                ->listDeliverables(array('client_id' => $client_id)));
            foreach ($objs as &$obj) {
                $obj['id'] = 'hermes:' . $obj['id'];
            }

            return $objs;
        }

        $elts = array();
        foreach (Hermes::getCostObjects($client_id, true) as $category) {
            Horde_Array::arraySort($category['objects'], 'name');
            foreach ($category['objects'] as $object) {
                $elts[] = array(
                    'id' => $object['id'],
                    'client_id' => false,
                    'name' => sprintf('%s (%s)', htmlspecialchars(Horde_String::truncate($object['name'], 80)), htmlspecialchars($category['category'])),
                    'parent' => empty($object['parent']) ? 0 : $object['parent'],
                    'estimate' => empty($object['estimate']) ? 0 : $object['estimate'],
                    'active' => true,
                    'is_external' => true
                );
            }
        }

        return array_values($elts);
    }

    public function getDeliverableDetail()
    {
        global $injector;

        $filters = array(
            'costobject' => $this->vars->id
        );
        $hours = $injector->getInstance('Hermes_Driver')->getHours($filters);
        $json = array();
        foreach ($hours as $h) {
            $json[] = $h->toJson();
        }

        return $json;
    }

    /**
     * Return descriptions of job types. If $this->vars->id is present it is
     * used to filter by the requested id.
     *
     * @return array An array describing the type.
     */
    public function listJobTypes()
    {
        $id = !empty($this->vars->id) ? $this->vars->id : null;
        return array_values($GLOBALS['injector']
            ->getInstance('Hermes_Driver')
            ->listJobTypes(array('id' => $id)));
    }

    /**
     * Return the current list of timers.
     *
     * @param boolean $running_only  Only return running timers if true.
     *
     * @return array  An array of timer arrays. @see Hermes::listTimers()
     */
    public function listTimers($running_only = false)
    {
        return Hermes::listTimers($running_only);
    }

    /**
     * Fetch a collection of time slices. For now, just allows a search for
     * all of a single employees time. Either submitted or not submitted.
     * Expects the following values in $this->vars:
     *   - e:     The employee id
     *   - s:     Include submitted slices if true
     *   - sort:  The sort-by value
     *   - dir:   The sort direction
     *
     * @return array  An array of time slice data.
     */
    public function loadSlices()
    {
        $params = array(
            'employee' => $this->vars->e,
            'submitted' => $this->vars->s);

        $json = array();
        try {
            $slices = $GLOBALS['injector']
                ->getInstance('Hermes_Driver')
                ->getHours($params);
            foreach ($slices as $slice) {
                $json[] = $slice->toJson();
            }
        } catch (Hermes_Exception $e) {
            $GLOBALS['notification']->push($e, 'horde.error');
        }

        return $json;
    }

    /**
     * Pause a timer. Expects the following data in $this->vars:
     *   - t: The timer id
     *
     * @return boolean
     */
    public function pauseTimer()
    {
        try {
            $timer = Hermes::getTimer($this->vars->t);
        } catch (Horde_Exception_NotFound $e) {
            $GLOBALS['notification']->push(_("Invalid timer requested"), 'horde.error');
            return false;
        }

        // Avoid pausing the same timer twice.
        if ($timer['paused'] || $timer['time'] == 0) {
            return true;
        }
        $timer['paused'] = true;
        $timer['elapsed'] += time() - $timer['time'];
        $timer['time'] = 0;
        Hermes::updateTimer($this->vars->t, $timer);

        return true;
    }

    /**
     * Poll the server. Currently also returns the list of current timer data
     * so the UI can be updated periodically.
     *
     * @return array  An array of timer arrays. @see self::listTimers()
     */
    public function poll()
    {
        // Return any elapsed time for timers
        return $this->listTimers(true);
    }

    /**
     * Perform a slice search.
     *
     * @return array  The search results.
     */
    public function search()
    {
        $criteria = $this->_readSearchForm();

        $slices = $GLOBALS['injector']
            ->getInstance('Hermes_Driver')
            ->getHours($criteria);
        $json = array();

        foreach ($slices as $slice) {
            $json[] = $slice->toJson();
        }
        return $json;
    }

    /**
     * Restart a paused timer. Expects the following data in $this->vars:
     *   - t:  The timer id.
     *
     * @return boolean
     */
    public function startTimer()
    {
        try {
            $timer = Hermes::getTimer($this->vars->t);
        } catch (Horde_Exception_NotFound $e) {
            $GLOBALS['notification']->push(_("Invalid timer requested"), 'horde.error');
            return false;
        }
        $timer['paused'] = false;
        $timer['time'] = time();
        Hermes::updateTimer($this->vars->t, $timer);

        return true;
    }

    /**
     * Stop a timer. Expects the following in $this->vars:
     *   - t:  The timer id.
     *   - restart:
     *
     * @return array  An array describing the current timer state. Contains:
     *  - h: The total number of hours elapsed so far.
     *  - n: A note to apply to the description field of a time slice.
     *  - t: The new timer title, if restarting.
     */
    public function stopTimer()
    {
        global $prefs;

        try {
            $timer = Hermes::getTimer($this->vars->t);
        } catch (Horde_Exception_NotFound $e) {
            $GLOBALS['notification']->push(_("Invalid timer requested"), 'horde.error');
            return false;
        }
        $results = $timer;
        $tname = $timer['name'];
        $elapsed = ((!$timer['paused']) ? time() - $timer['time'] : 0 ) + $timer['elapsed'];

        $results['h'] = round((float)$elapsed / 3600, 2);
        if ($prefs->getValue('add_description')) {
            $results['n'] = sprintf(_("Using the \"%s\" stop watch from %s %s to %s %s"), $tname, strftime($prefs->getValue('date_format_mini'), $this->vars->t), strftime($prefs->getValue('time_format'), $this->vars->t), strftime($prefs->getValue('date_format_mini'), time()), strftime($prefs->getValue('time_format'), time()));
        } else {
            $results['n'] = '';
        }
        $GLOBALS['notification']->push(sprintf(_("The stop watch \"%s\" has been stopped."), $tname), 'horde.success');

        Hermes::clearTimer($this->vars->t);
        if ($this->vars->restart == 'true') {
            $now = time();
            $timer['elapsed'] = 0;
            $timer['paused'] = $results['paused'] = true;
            $timer['time'] = $now;
            Hermes::updateTimer($this->vars->t, $timer);
        }

        return $results;
    }

    /**
     * Mark slices as submitted.  Expects the following in $this->vars:
     *   - items:  The slice ids to submit.
     *
     * @return boolean
     */
    public function submitSlices()
    {
        $time = array();
        foreach (explode(':', $this->vars->items) as $id) {
            $time[] = array('id' => $id);
        }
        try {
            $GLOBALS['injector']
                ->getInstance('Hermes_Driver')
                ->markAs('submitted', $time);
        } catch (Horde_Exception $e) {
            $GLOBALS['notification']->push(sprintf(_("There was an error submitting your time: %s"), $e->getMessage()), 'horde.error');
            return false;
        }

        $GLOBALS['notification']->push(_("Your time was successfully submitted."), 'horde.success');
        return true;
    }

    /**
     * Update an existing jobtype. Takes the following from $this->vars:
     *   - id:       (integer) The type id of the exsting type.
     *   - name:     (string)  They type name.
     *   - billable: (boolean) Is this type billable?
     *   - enabled:  (boolean) Is this type enabled?
     *   - rate:     (double)  The default hourly rate to use for this type.
     *
     * @return boolean  True on success/false on failure.
     */
    public function updateJobType()
    {
        $job = array(
            'id' => $this->vars->job_id,
            'name' => $this->vars->name,
            'billable' => $this->vars->billable == 'on',
            'enabled' => $this->vars->enabled == 'on',
            'rate' => $this->vars->rate);
        try {
            $GLOBALS['injector']
                ->getInstance('Hermes_Driver')
                ->updateJobType($job);
        } catch (Hermes_Exception $e) {
            $GLOBALS['notification']->push($e->getMessage(), 'horde.error');
            return false;
        }
        $GLOBALS['notification']->push(_("Job type successfully updated."), 'horde.success');

        return true;
    }

    /**
     * Update a slice. @see Hermes_Slice::readForm() for the data expeted in
     * the posted form.
     *
     * @return array  The new slice data.
     */
    public function updateSlice()
    {
        $slice = new Hermes_Slice();
        $slice->readForm();
        try {
            $GLOBALS['injector']->getInstance('Hermes_Driver')->updateTime(array($slice));
            if ($slice['employee'] == $GLOBALS['registry']->getAuth()) {
                $GLOBALS['notification']->push(_("Your time was successfully updated."), 'horde.success');
            } else {
                $GLOBALS['notification']->push(sprintf(_("The time was successfully updated and saved to the time sheet of %s."), $slice['employee']), 'horde.success');
            }

            $new = $GLOBALS['injector']->getInstance('Hermes_Driver')->getHours(array('id' => $slice['id']));
            return current($new)->toJson();
        } catch (Hermes_Exception $e) {
            $GLOBALS['notification']->push($e, 'horde.error');
        }
    }

    /**
     * Reads the search form submitted and return the search criteria
     *
     */
    protected function _readSearchForm()
    {
        $perms = $GLOBALS['injector']->getInstance('Horde_Perms');
        $vars = $this->vars;

        $criteria = array();
        if ($GLOBALS['registry']->isAdmin(array('permission' => 'hermes:review'))) {
            if (!empty($vars->employees[0])) {
                $auth = $GLOBALS['injector']->getInstance('Horde_Core_Factory_Auth')->create();
                if (!$auth->hasCapability('list')) {
                    $criteria['employee'] = explode(',', $vars->employees[0]);
                    if (empty($criteria['employee'])) {
                        unset($criteria['employee']);
                    }
                } else {
                    $criteria['employee'] = $vars->employees;
                }
            }
        } else {
            $criteria['employee'] = $GLOBALS['registry']->getAuth();
        }
        if (!empty($vars->client)) {
            $criteria['client'] = $vars->client;
        }
        if (!empty($vars->type)) {
            $criteria['jobtype'] = $vars->type;
        }
        if (!empty($vars->costobject)) {
            $criteria['costobject'] = $vars->costobject;
        }
        if (!empty($vars->after_date)) {
            $dt = new Horde_Date($vars->after_date);
            $criteria['start'] = $dt->timestamp();
        }
        if (!empty($vars->before_date)) {
            $dt = new Horde_Date($vars->before_date);
            $criteria['end'] = $dt->add(86400)->timestamp();
        }

        if ($vars->billable !== '') {
            $criteria['billable'] = $vars->billable;
        }
        if ($vars->submitted !== '') {
            $criteria['submitted'] = $vars->submitted;
        }
        if ($vars->exported !== '') {
            $criteria['exported'] = $vars->exported;
        }

        return $criteria;
    }

}