plugins/Sitemap/actions/sitemap.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Superclass for sitemap-generating actions
   6  *
   7  * PHP version 5
   8  *
   9  * LICENCE: This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU Affero General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Affero General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  * @category  Sitemap
  23  * @package   StatusNet
  24  * @author    Evan Prodromou <evan@status.net>
  25  * @copyright 2010 StatusNet, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://status.net/
  28  */
  29
  30 if (!defined('STATUSNET')) {
  31     exit(1);
  32 }
  33
  34 /**
  35  * superclass for sitemap actions
  36  *
  37  * @category Sitemap
  38  * @package  StatusNet
  39  * @author   Evan Prodromou <evan@status.net>
  40  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  41  * @link     http://status.net/
  42  */
  43 class SitemapAction extends Action
  44 {
  45     /**
  46      * handle the action
  47      *
  48      * @param array $args unused.
  49      *
  50      * @return void
  51      */
  52     function handle(array $args=array())
  53     {
  54         parent::handle($args);
  55
  56         header('Content-Type: text/xml; charset=UTF-8');
  57         $this->startXML();
  58
  59         $this->elementStart('urlset', array('xmlns' => 'http://www.sitemaps.org/schemas/sitemap/0.9'));
  60
  61         while (list($url, $lm, $cf, $p) = $this->nextUrl()) {
  62             $this->showUrl($url, $lm, $cf, $p);
  63         }
  64
  65         $this->elementEnd('urlset');
  66
  67         $this->endXML();
  68     }
  69
  70     function lastModified()
  71     {
  72         $y = $this->trimmed('year');
  73
  74         $m = $this->trimmed('month');
  75         $d = $this->trimmed('day');
  76
  77         $y += 0;
  78         $m += 0;
  79         $d += 0;
  80
  81         $begdate = strtotime("$y-$m-$d 00:00:00");
  82         $enddate = $begdate + (24 * 60 * 60);
  83
  84         if ($enddate < time()) {
  85             return $enddate;
  86         } else {
  87             return null;
  88         }
  89     }
  90
  91     function showUrl($url, $lastMod=null, $changeFreq=null, $priority=null)
  92     {
  93         $this->elementStart('url');
  94         $this->element('loc', null, $url);
  95         if (!is_null($lastMod)) {
  96             $this->element('lastmod', null, $lastMod);
  97         }
  98         if (!is_null($changeFreq)) {
  99             $this->element('changefreq', null, $changeFreq);
 100         }
 101         if (!is_null($priority)) {
 102             $this->element('priority', null, $priority);
 103         }
 104         $this->elementEnd('url');
 105     }
 106
 107     function nextUrl()
 108     {
 109         return null;
 110     }
 111
 112     function isReadOnly()
 113     {
 114         return true;
 115     }
 116 }