includes/api/ApiQueryExternalLinks.php

   1 <?php
   2
   3 /*
   4  * Created on May 13, 2007
   5  *
   6  * API for MediaWiki 1.8+
   7  *
   8  * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License along
  21  * with this program; if not, write to the Free Software Foundation, Inc.,
  22  * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  23  * http://www.gnu.org/copyleft/gpl.html
  24  */
  25
  26 if (!defined('MEDIAWIKI')) {
  27         // Eclipse helper - will be ignored in production
  28         require_once ("ApiQueryBase.php");
  29 }
  30
  31 /**
  32  * A query module to list all external URLs found on a given set of pages.
  33  *
  34  * @addtogroup API
  35  */
  36 class ApiQueryExternalLinks extends ApiQueryBase {
  37
  38         public function __construct($query, $moduleName) {
  39                 parent :: __construct($query, $moduleName, 'el');
  40         }
  41
  42         public function execute() {
  43
  44                 $this->addFields(array (
  45                         'el_from',
  46                         'el_to'
  47                 ));
  48
  49                 $this->addTables('externallinks');
  50                 $this->addWhereFld('el_from', array_keys($this->getPageSet()->getGoodTitles()));
  51
  52                 $db = $this->getDB();
  53                 $res = $this->select(__METHOD__);
  54
  55                 $data = array();
  56                 $lastId = 0;    // database has no ID 0
  57                 while ($row = $db->fetchObject($res)) {
  58                         if ($lastId != $row->el_from) {
  59                                 if($lastId != 0) {
  60                                         $this->addPageSubItems($lastId, $data);
  61                                         $data = array();
  62                                 }
  63                                 $lastId = $row->el_from;
  64                         }
  65
  66                         $entry = array();
  67                         ApiResult :: setContent($entry, $row->el_to);
  68                         $data[] = $entry;
  69                 }
  70
  71                 if($lastId != 0) {
  72                         $this->addPageSubItems($lastId, $data);
  73                 }
  74
  75                 $db->freeResult($res);
  76         }
  77
  78         private function addPageSubItems($pageId, $data) {
  79                 $result = $this->getResult();
  80                 $result->setIndexedTagName($data, 'el');
  81                 $result->addValue(array ('query', 'pages', intval($pageId)),
  82                         'extlinks',
  83                         $data);
  84         }
  85
  86         protected function getDescription() {
  87                 return 'Returns all external urls (not interwikies) from the given page(s)';
  88         }
  89
  90         protected function getExamples() {
  91                 return array (
  92                                 "Get a list of external links on the [[Main Page]]:",
  93                                 "  api.php?action=query&prop=extlinks&titles=Main%20Page",
  94                         );
  95         }
  96
  97         public function getVersion() {
  98                 return __CLASS__ . ': $Id$';
  99         }
 100 }
 101 ?>