Source for file message.php

Documentation is available at message.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Administrator
  4.  * @subpackage  com_messages
  5.  *
  6.  * @copyright   Copyright (C) 2005 - 2013 Open Source Matters, Inc. All rights reserved.
  7.  * @license     GNU General Public License version 2 or later; see LICENSE.txt
  8.  */
  9.  
  10. defined('_JEXEC') or die;
  11.  
  12. /**
  13.  * Private Message model.
  14.  *
  15.  * @package     Joomla.Administrator
  16.  * @subpackage  com_messages
  17.  * @since       1.6
  18.  */
  19. class MessagesModelMessage extends JModelAdmin
  20. {
  21.     /**
  22.      * message
  23.      */
  24.     protected $item;
  25.  
  26.     /**
  27.      * Method to auto-populate the model state.
  28.      *
  29.      * Note. Calling getState in this method will result in recursion.
  30.      *
  31.      * @since   1.6
  32.      */
  33.     protected function populateState()
  34.     {
  35.         parent::populateState();
  36.  
  37.         $input = JFactory::getApplication()->input;
  38.  
  39.         $user = JFactory::getUser();
  40.         $this->setState('user.id', $user->get('id'));
  41.  
  42.         $messageId = (int) $input->getInt('message_id');
  43.         $this->setState('message.id', $messageId);
  44.  
  45.         $replyId = (int) $input->getInt('reply_id');
  46.         $this->setState('reply.id', $replyId);
  47.     }
  48.  
  49.     /**
  50.      * Check that recipient user is the one trying to delete and then call parent delete method
  51.      *
  52.      * @param   array  &$pks  An array of record primary keys.
  53.      *
  54.      * @return  boolean  True if successful, false if an error occurs.
  55.      *
  56.      * @since  3.1
  57.      */
  58.     public function delete(&$pks)
  59.     {
  60.         $pks = (array) $pks;
  61.         $table = $this->getTable();
  62.         $user = JFactory::getUser();
  63.  
  64.         // Iterate the items to delete each one.
  65.         foreach ($pks as $i => $pk)
  66.         {
  67.             if ($table->load($pk))
  68.             {
  69.                 if ($table->user_id_to !== $user->id)
  70.                 {
  71.                     // Prune items that you can't change.
  72.                     unset($pks[$i]);
  73.                     JLog::add(JText::_('JLIB_APPLICATION_ERROR_DELETE_NOT_PERMITTED'), JLog::WARNING, 'jerror');
  74.                     return false;
  75.                 }
  76.             }
  77.             else
  78.             {
  79.                 $this->setError($table->getError());
  80.                 return false;
  81.             }
  82.         }
  83.         return parent::delete($pks);
  84.     }
  85.  
  86.     /**
  87.      * Returns a Table object, always creating it.
  88.      *
  89.      * @param   type    The table type to instantiate
  90.      * @param   string    A prefix for the table class name. Optional.
  91.      * @param   array  Configuration array for model. Optional.
  92.      * @return  JTable    A database object
  93.      * @since   1.6
  94.     */
  95.     public function getTable($type = 'Message', $prefix = 'MessagesTable', $config = array())
  96.     {
  97.         return JTable::getInstance($type, $prefix, $config);
  98.     }
  99.  
  100.     /**
  101.      * Method to get a single record.
  102.      *
  103.      * @param   integer    The id of the primary key.
  104.      * @return  mixed  Object on success, false on failure.
  105.      * @since   1.6
  106.      */
  107.     public function getItem($pk = null)
  108.     {
  109.         if (!isset($this->item))
  110.         {
  111.             if ($this->item = parent::getItem($pk))
  112.             {
  113.                 // Prime required properties.
  114.                 if (empty($this->item->message_id))
  115.                 {
  116.                     // Prepare data for a new record.
  117.                     if ($replyId = $this->getState('reply.id'))
  118.                     {
  119.                         // If replying to a message, preload some data.
  120.                         $db        = $this->getDbo();
  121.                         $query    = $db->getQuery(true)
  122.                             ->select('subject, user_id_from')
  123.                             ->from('#__messages')
  124.                             ->where('message_id = '.(int) $replyId);
  125.  
  126.                         try
  127.                         {
  128.                             $message = $db->setQuery($query)->loadObject();
  129.                         }
  130.                         catch (RuntimeException $e)
  131.                         {
  132.                             $this->setError($e->getMessage());
  133.                             return false;
  134.                         }
  135.  
  136.                         $this->item->set('user_id_to', $message->user_id_from);
  137.                         $re = JText::_('COM_MESSAGES_RE');
  138.                         if (stripos($message->subject, $re) !== 0)
  139.                         {
  140.                             $this->item->set('subject', $re.$message->subject);
  141.                         }
  142.                     }
  143.                 }
  144.                 elseif ($this->item->user_id_to != JFactory::getUser()->id)
  145.                 {
  146.                     $this->setError(JText::_('JERROR_ALERTNOAUTHOR'));
  147.                     return false;
  148.                 }
  149.                 else {
  150.                     // Mark message read
  151.                     $db        = $this->getDbo();
  152.                     $query    = $db->getQuery(true)
  153.                         ->update('#__messages')
  154.                         ->set('state = 1')
  155.                         ->where('message_id = '.$this->item->message_id);
  156.                     $db->setQuery($query)->execute();
  157.                 }
  158.             }
  159.  
  160.             // Get the user name for an existing messasge.
  161.             if ($this->item->user_id_from && $fromUser = new JUser($this->item->user_id_from))
  162.             {
  163.                 $this->item->set('from_user_name', $fromUser->name);
  164.             }
  165.         }
  166.         return $this->item;
  167.     }
  168.  
  169.     /**
  170.      * Method to get the record form.
  171.      *
  172.      * @param   array  $data        Data for the form.
  173.      * @param   boolean    $loadData    True if the form is to load its own data (default case), false if not.
  174.      * @return  JForm    A JForm object on success, false on failure
  175.      * @since   1.6
  176.      */
  177.     public function getForm($data = array(), $loadData = true)
  178.     {
  179.         // Get the form.
  180.         $form = $this->loadForm('com_messages.message', 'message', array('control' => 'jform', 'load_data' => $loadData));
  181.         if (empty($form))
  182.         {
  183.             return false;
  184.         }
  185.  
  186.         return $form;
  187.     }
  188.  
  189.     /**
  190.      * Method to get the data that should be injected in the form.
  191.      *
  192.      * @return  mixed  The data for the form.
  193.      * @since   1.6
  194.      */
  195.     protected function loadFormData()
  196.     {
  197.         // Check the session for previously entered form data.
  198.         $data = JFactory::getApplication()->getUserState('com_messages.edit.message.data', array());
  199.  
  200.         if (empty($data))
  201.         {
  202.             $data = $this->getItem();
  203.         }
  204.  
  205.         $this->preprocessData('com_messages.message', $data);
  206.  
  207.         return $data;
  208.     }
  209.  
  210.     /**
  211.      * Checks that the current user matches the message recipient and calls the parent publish method
  212.      *
  213.      * @param   array    &$pks   A list of the primary keys to change.
  214.      * @param   integer  $value  The value of the published state.
  215.      *
  216.      * @return  boolean  True on success.
  217.      *
  218.      * @since   3.1
  219.      */
  220.     public function publish(&$pks, $value = 1)
  221.     {
  222.         $user = JFactory::getUser();
  223.         $table = $this->getTable();
  224.         $pks = (array) $pks;
  225.  
  226.         // Check that the recipient matches the current user
  227.         foreach ($pks as $i => $pk)
  228.         {
  229.             $table->reset();
  230.  
  231.             if ($table->load($pk))
  232.             {
  233.                 if ($table->user_id_to !== $user->id)
  234.                 {
  235.                     // Prune items that you can't change.
  236.                     unset($pks[$i]);
  237.                     JLog::add(JText::_('JLIB_APPLICATION_ERROR_EDITSTATE_NOT_PERMITTED'), JLog::WARNING, 'jerror');
  238.                     return false;
  239.                 }
  240.             }
  241.  
  242.         }
  243.  
  244.         return parent::publish($pks, $value);
  245.     }
  246.  
  247.     /**
  248.      * Method to save the form data.
  249.      *
  250.      * @param   array  The form data.
  251.      *
  252.      * @return  boolean  True on success.
  253.      */
  254.     public function save($data)
  255.     {
  256.         $table = $this->getTable();
  257.  
  258.         // Bind the data.
  259.         if (!$table->bind($data))
  260.         {
  261.             $this->setError($table->getError());
  262.             return false;
  263.         }
  264.  
  265.         // Assign empty values.
  266.         if (empty($table->user_id_from))
  267.         {
  268.             $table->user_id_from = JFactory::getUser()->get('id');
  269.         }
  270.         if ((int) $table->date_time == 0)
  271.         {
  272.             $table->date_time = JFactory::getDate()->toSql();
  273.         }
  274.  
  275.         // Check the data.
  276.         if (!$table->check())
  277.         {
  278.             $this->setError($table->getError());
  279.             return false;
  280.         }
  281.  
  282.         // Load the recipient user configuration.
  283.         $model = JModelLegacy::getInstance('Config', 'MessagesModel', array('ignore_request' => true));
  284.         $model->setState('user.id', $table->user_id_to);
  285.         $config = $model->getItem();
  286.         if (empty($config))
  287.         {
  288.             $this->setError($model->getError());
  289.             return false;
  290.         }
  291.  
  292.         if ($config->get('locked', false))
  293.         {
  294.             $this->setError(JText::_('COM_MESSAGES_ERR_SEND_FAILED'));
  295.             return false;
  296.         }
  297.  
  298.         // Store the data.
  299.         if (!$table->store())
  300.         {
  301.             $this->setError($table->getError());
  302.             return false;
  303.         }
  304.  
  305.         if ($config->get('mail_on_new', true))
  306.         {
  307.             // Load the user details (already valid from table check).
  308.             $fromUser = JUser::getInstance($table->user_id_from);
  309.             $toUser = JUser::getInstance($table->user_id_to);
  310.             $debug = JFactory::getConfig()->get('debug_lang');
  311.             $default_language = JComponentHelper::getParams('com_languages')->get('administrator');
  312.             $lang = JLanguage::getInstance($toUser->getParam('admin_language', $default_language), $debug);
  313.             $lang->load('com_messages', JPATH_ADMINISTRATOR);
  314.  
  315.             $siteURL  = JUri::root() . 'administrator/index.php?option=com_messages&view=message&message_id='.$table->message_id;
  316.             $sitename = JFactory::getApplication()->getCfg('sitename');
  317.  
  318.             $subject = sprintf($lang->_('COM_MESSAGES_NEW_MESSAGE_ARRIVED'), $sitename);
  319.             $msg     = sprintf($lang->_('COM_MESSAGES_PLEASE_LOGIN'), $siteURL);
  320.             JFactory::getMailer()->sendMail($fromUser->email, $fromUser->name, $toUser->email, $subject, $msg);
  321.         }
  322.  
  323.         return true;
  324.     }
  325. }

Documentation generated on Tue, 19 Nov 2013 15:08:04 +0100 by phpDocumentor 1.4.3