includes/filebackend/filejournal/DBFileJournal.php

   1 <?php
   2 /**
   3  * Version of FileJournal that logs to a DB table.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup FileJournal
  22  * @author Aaron Schulz
  23  */
  24
  25 /**
  26  * Version of FileJournal that logs to a DB table
  27  * @since 1.20
  28  */
  29 class DBFileJournal extends FileJournal {
  30         /** @var DatabaseBase */
  31         protected $dbw;
  32
  33         protected $wiki = false; // string; wiki DB name
  34
  35         /**
  36          * Construct a new instance from configuration.
  37          * $config includes:
  38          *     'wiki' : wiki name to use for LoadBalancer
  39          *
  40          * @param $config Array
  41          */
  42         protected function __construct( array $config ) {
  43                 parent::__construct( $config );
  44
  45                 $this->wiki = $config['wiki'];
  46         }
  47
  48         /**
  49          * @see FileJournal::logChangeBatch()
  50          * @return Status
  51          */
  52         protected function doLogChangeBatch( array $entries, $batchId ) {
  53                 $status = Status::newGood();
  54
  55                 try {
  56                         $dbw = $this->getMasterDB();
  57                 } catch ( DBError $e ) {
  58                         $status->fatal( 'filejournal-fail-dbconnect', $this->backend );
  59                         return $status;
  60                 }
  61
  62                 $now = wfTimestamp( TS_UNIX );
  63
  64                 $data = array();
  65                 foreach ( $entries as $entry ) {
  66                         $data[] = array(
  67                                 'fj_batch_uuid' => $batchId,
  68                                 'fj_backend'    => $this->backend,
  69                                 'fj_op'         => $entry['op'],
  70                                 'fj_path'       => $entry['path'],
  71                                 'fj_new_sha1'   => $entry['newSha1'],
  72                                 'fj_timestamp'  => $dbw->timestamp( $now )
  73                         );
  74                 }
  75
  76                 try {
  77                         $dbw->insert( 'filejournal', $data, __METHOD__ );
  78                 } catch ( DBError $e ) {
  79                         $status->fatal( 'filejournal-fail-dbquery', $this->backend );
  80                         return $status;
  81                 }
  82
  83                 return $status;
  84         }
  85
  86         /**
  87          * @see FileJournal::doGetChangeEntries()
  88          * @return Array
  89          * @throws DBError
  90          */
  91         protected function doGetChangeEntries( $start, $limit ) {
  92                 $dbw = $this->getMasterDB();
  93
  94                 $res = $dbw->select( 'filejournal', '*',
  95                         array(
  96                                 'fj_backend' => $this->backend,
  97                                 'fj_id >= ' . $dbw->addQuotes( (int)$start ) ), // $start may be 0
  98                         __METHOD__,
  99                         array_merge( array( 'ORDER BY' => 'fj_id ASC' ),
 100                                 $limit ? array( 'LIMIT' => $limit ) : array() )
 101                 );
 102
 103                 $entries = array();
 104                 foreach ( $res as $row ) {
 105                         $item = array();
 106                         foreach ( (array)$row as $key => $value ) {
 107                                 $item[substr( $key, 3 )] = $value; // "fj_op" => "op"
 108                         }
 109                         $entries[] = $item;
 110                 }
 111
 112                 return $entries;
 113         }
 114
 115         /**
 116          * @see FileJournal::purgeOldLogs()
 117          * @return Status
 118          * @throws DBError
 119          */
 120         protected function doPurgeOldLogs() {
 121                 $status = Status::newGood();
 122                 if ( $this->ttlDays <= 0 ) {
 123                         return $status; // nothing to do
 124                 }
 125
 126                 $dbw = $this->getMasterDB();
 127                 $dbCutoff = $dbw->timestamp( time() - 86400 * $this->ttlDays );
 128
 129                 $dbw->delete( 'filejournal',
 130                         array( 'fj_timestamp < ' . $dbw->addQuotes( $dbCutoff ) ),
 131                         __METHOD__
 132                 );
 133
 134                 return $status;
 135         }
 136
 137         /**
 138          * Get a master connection to the logging DB
 139          *
 140          * @return DatabaseBase
 141          * @throws DBError
 142          */
 143         protected function getMasterDB() {
 144                 if ( !$this->dbw ) {
 145                         // Get a separate connection in autocommit mode
 146                         $lb = wfGetLBFactory()->newMainLB();
 147                         $this->dbw = $lb->getConnection( DB_MASTER, array(), $this->wiki );
 148                         $this->dbw->clearFlag( DBO_TRX );
 149                 }
 150                 return $this->dbw;
 151         }
 152 }