lib/action.php

   1 <?php
   2 /*
   3  * Laconica - a distributed open-source microblogging tool
   4  * Copyright (C) 2008, Controlez-Vous, Inc.
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU Affero General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU Affero General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Affero General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 if (!defined('LACONICA')) { exit(1); }
  21
  22 class Action { // lawsuit
  23
  24         var $args;
  25
  26         function Action() {
  27         }
  28
  29         # For initializing members of the class
  30
  31         function prepare($argarray) {
  32                 $this->args =& common_copy_args($argarray);
  33                 return true;
  34         }
  35
  36         # For comparison with If-Last-Modified
  37         # If not applicable, return NULL
  38
  39         function last_modified() {
  40                 return NULL;
  41         }
  42
  43         function etag() {
  44                 return NULL;
  45         }
  46
  47         function is_readonly() {
  48                 return false;
  49         }
  50
  51         function arg($key, $def=NULL) {
  52                 if (array_key_exists($key, $this->args)) {
  53                         return $this->args[$key];
  54                 } else {
  55                         return $def;
  56                 }
  57         }
  58
  59         function trimmed($key, $def=NULL) {
  60                 $arg = $this->arg($key, $def);
  61                 return (is_string($arg)) ? trim($arg) : $arg;
  62         }
  63
  64         # Note: argarray ignored, since it's now passed in in prepare()
  65
  66         function handle($argarray=NULL) {
  67
  68                 $lm = $this->last_modified();
  69                 $etag = $this->etag();
  70
  71                 if ($etag) {
  72                         header('ETag: ' . $etag);
  73                 }
  74
  75                 if ($lm) {
  76                         header('Last-Modified: ' . date(DATE_RFC1123, $lm));
  77                         $if_modified_since = $_SERVER['HTTP_IF_MODIFIED_SINCE'];
  78                         if ($if_modified_since) {
  79                                 $ims = strtotime($if_modified_since);
  80                                 if ($lm <= $ims) {
  81                                         if (!$etag || $this->_has_etag($etag, $_SERVER['HTTP_IF_NONE_MATCH'])) {
  82                                                 header('HTTP/1.1 304 Not Modified');
  83                                                 # Better way to do this?
  84                                                 exit(0);
  85                                         }
  86                                 }
  87                         }
  88                 }
  89         }
  90
  91         function _has_etag($etag, $if_none_match) {
  92                 return ($if_none_match) && in_array($etag, explode(',', $if_none_match));
  93         }
  94
  95         function boolean($key, $def=false) {
  96                 $arg = strtolower($this->trimmed($key));
  97
  98                 if (is_null($arg)) {
  99                         return $def;
 100                 } else if (in_array($arg, array('true', 'yes', '1'))) {
 101                         return true;
 102                 } else if (in_array($arg, array('false', 'no', '0'))) {
 103                         return false;
 104                 } else {
 105                         return $def;
 106                 }
 107         }
 108
 109         function server_error($msg, $code=500) {
 110                 $action = $this->trimmed('action');
 111                 common_debug("Server error '$code' on '$action': $msg", __FILE__);
 112                 common_server_error($msg, $code);
 113         }
 114
 115         function client_error($msg, $code=400) {
 116                 $action = $this->trimmed('action');
 117                 common_debug("User error '$code' on '$action': $msg", __FILE__);
 118                 common_user_error($msg, $code);
 119         }
 120
 121         function self_url() {
 122                 $action = $this->trimmed('action');
 123                 $args = $this->args;
 124                 unset($args['action']);
 125                 foreach (array_keys($_COOKIE) as $cookie) {
 126                         unset($args[$cookie]);
 127                 }
 128                 return common_local_url($action, $args);
 129         }
 130
 131         function nav_menu($menu) {
 132         $action = $this->trimmed('action');
 133         common_element_start('ul', array('id' => 'nav_views'));
 134         foreach ($menu as $menuaction => $menudesc) {
 135             common_menu_item(common_local_url($menuaction, isset($menudesc[2]) ? $menudesc[2] : NULL),
 136                                                          $menudesc[0],
 137                                                          $menudesc[1],
 138                                                          $action == $menuaction);
 139         }
 140         common_element_end('ul');
 141         }
 142 }