includes/class_logging.php

   1 <?php
   2 /*=====================================================================*\
   3 || ###################################################################
   4 || # Bugdar [#]version[#]
   5 || # Copyright ©2002-[#]year[#] Blue Static
   6 || #
   7 || # This program is free software; you can redistribute it and/or modify
   8 || # it under the terms of the GNU General Public License as published by
   9 || # the Free Software Foundation; version [#]gpl[#] of the License.
  10 || #
  11 || # This program is distributed in the hope that it will be useful, but
  12 || # WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  13 || # or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
  14 || # more details.
  15 || #
  16 || # You should have received a copy of the GNU General Public License along
  17 || # with this program; if not, write to the Free Software Foundation, Inc.,
  18 || # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
  19 || ###################################################################
  20 \*=====================================================================*/
  21
  22 /*
  23 A USEFUL QUERY:
  24
  25 DELETE FROM history WHERE field IN ('lastposttime', 'lastpostby', 'hiddenlastposttime', 'hiddenlastpostby')
  26
  27 */
  28
  29 /**
  30 * Bug Change Logging
  31 *
  32 * This class is used to record changes in a bug's fields, comments, and
  33 * attachments.
  34 *
  35 * @author               Blue Static
  36 * @copyright    Copyright ©2002 - [#]year[#], Blue Static
  37 * @version              $Revision$
  38 * @package              Bugdar
  39 *
  40 */
  41 class Logging
  42 {
  43         /**
  44         * Bug ID
  45         * @var  integer
  46         * @access       private
  47         */
  48         var $bugid = 0;
  49
  50         /**
  51         * Attachment ID
  52         * @var  integer
  53         * @access       private
  54         */
  55         var $attachmentid = 0;
  56
  57         /**
  58         * Comment ID
  59         * @var  integer
  60         * @access       private
  61         */
  62         var $commentid = 0;
  63
  64         /**
  65         * The original data to compare against
  66         * @var  array
  67         * @access       private
  68         */
  69         var $original = array();
  70
  71         /**
  72         * Modified data
  73         * @var  array
  74         * @access       private
  75         */
  76         var $modified = array();
  77
  78         /**
  79         * Compared/diff'd data
  80         * @var  array
  81         * @access       private
  82         */
  83         var $compared = array();
  84
  85         // ###################################################################
  86         /**
  87         * Sets the bug ID for the current logging instance
  88         *
  89         * @access       public
  90         *
  91         * @param        integer New bug ID
  92         */
  93         function set_bugid($id)
  94         {
  95                 global $bugsys;
  96                 $this->bugid = $bugsys->clean($id, TYPE_UINT);
  97         }
  98
  99         // ###################################################################
 100         /**
 101         * Sets the attachment ID for the current logging instance
 102         *
 103         * @access       public
 104         *
 105         * @param        integer New attachment ID
 106         */
 107         function set_attachmentid($id)
 108         {
 109                 global $bugsys;
 110                 $this->attachmentid = $bugsys->clean($id, TYPE_UINT);
 111         }
 112
 113         // ###################################################################
 114         /**
 115         * Sets the current comment ID to be logged
 116         *
 117         * @access       public
 118         *
 119         * @param        integer New comment ID
 120         */
 121         function set_commentid($id)
 122         {
 123                 global $bugsys;
 124                 $this->commentid = $bugsys->clean($id, TYPE_UINT);
 125         }
 126
 127         // ###################################################################
 128         /**
 129         * Assigns data into the $this->original or $this->modified array based
 130         * on the passed arrays of information and the fields to add (and what
 131         * name to add them under), and any prefix
 132         *
 133         * @access       public
 134         *
 135         * @param        bool    TRUE for original, FALSE for modified
 136         * @param        array   Data array
 137         * @param        array   List of fields in the data array to add; in format of array('field name' => 'display name', 'display name 2', 'display name 3')
 138         * @param        bool    If TRUE, then the list of fields is used to exclude, not include
 139         * @param        string  Field prefix
 140         */
 141         function add_data($orig, $data, $fields, $exclude = false,  $prefix = '')
 142         {
 143                 $array = ($orig ? 'original' : 'modified');
 144                 $prefix .= '.';
 145
 146                 if ($exclude == false)
 147                 {
 148                         foreach ($fields AS $fname => $fdisplay)
 149                         {
 150                                 if (is_numeric($fname))
 151                                 {
 152                                         $fname = $fdisplay;
 153                                 }
 154
 155                                 $this->{$array}["$prefix$fdisplay"] = array('name' => $fname, 'value' => $data["$fname"]);
 156                         }
 157                 }
 158                 else
 159                 {
 160                         foreach ($data AS $fname => $value)
 161                         {
 162                                 if (!in_array($fname, $fields))
 163                                 {
 164                                         $this->{$array}["$prefix$fname"] = array('name' => $fname, 'value' => $value);
 165                                 }
 166                         }
 167                 }
 168         }
 169
 170         // ###################################################################
 171         /**
 172         * Populates the $this->compared array as a diff between the original
 173         * and modified data. This is then used to create the databse queries.
 174         *
 175         * @access       private
 176         */
 177         function compare_arrays()
 178         {
 179                 foreach ($this->modified AS $key => $value)
 180                 {
 181                         if ($this->original["$key"] != $value AND !($value['value'] == '' AND $this->original["$key"]['value'] == '0') AND !($this->original["$key"]['value'] == '' AND $value['value'] == '0'))
 182                         {
 183                                 $this->compared["$key"] = array('old' => $this->original["$key"]['value'], 'new' => $this->modified["$key"]['value']);
 184                         }
 185                 }
 186         }
 187
 188         // ###################################################################
 189         /**
 190         * Runs $this->compare_arrays() and then takes the result and prepares
 191         * it for insertion into the history database.
 192         *
 193         * @access       public
 194         */
 195         function update_history()
 196         {
 197                 global $bugsys;
 198
 199                 $this->compare_arrays();
 200
 201                 foreach ($this->compared AS $field => $values)
 202                 {
 203                         $bugsys->db->query("
 204                                 INSERT INTO " . TABLE_PREFIX . "history
 205                                         (bugid, attachmentid, commentid, dateline, userid, field, original, changed)
 206                                 VALUES
 207                                         (" . $bugsys->clean($this->bugid, TYPE_UINT) . ", " . $bugsys->clean($this->attachmentid, TYPE_UINT) . ",
 208                                         " . $bugsys->clean($this->commentid, TYPE_UINT) . ", " . TIMENOW . ", " . $bugsys->userinfo['userid'] . ",
 209                                         '" . $bugsys->db->escape_string($field) . "', '" . $bugsys->db->escape_string($values['old']) . "',
 210                                         '" . $bugsys->db->escape_string($values['new']) . "'
 211                                 )
 212                         ");
 213                 }
 214         }
 215
 216         // ###################################################################
 217         /**
 218         * Returns an array of the fields commonly ignored
 219         *
 220         * @access       public
 221         *
 222         * @return       array   Fields ignored in logging
 223         */
 224         function getCommonFields()
 225         {
 226                 return array(
 227                         'bugid',
 228                         'lastposttime',
 229                         'lastpostby',
 230                         'lastpostbyname',
 231                         'hiddenlastposttime',
 232                         'hiddenlastpostby',
 233                         'hiddenlastpostbyname'
 234                 );
 235         }
 236 }
 237
 238 /*=====================================================================*\
 239 || ###################################################################
 240 || # $HeadURL$
 241 || # $Id$
 242 || ###################################################################
 243 \*=====================================================================*/
 244 ?>