lib/plugin/UpLoad.php

   1 <?php // -*-php-*-
   2 rcs_id('$Id: UpLoad.php,v 1.18 2005-02-12 17:24:24 rurban Exp $');
   3 /*
   4  Copyright 2003, 2004 $ThePhpWikiProgrammingTeam
   5
   6  This file is part of PhpWiki.
   7
   8  PhpWiki is free software; you can redistribute it and/or modify
   9  it under the terms of the GNU General Public License as published by
  10  the Free Software Foundation; either version 2 of the License, or
  11  (at your option) any later version.
  12
  13  PhpWiki is distributed in the hope that it will be useful,
  14  but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  GNU General Public License for more details.
  17
  18  You should have received a copy of the GNU General Public License
  19  along with PhpWiki; if not, write to the Free Software
  20  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21
  22  */
  23
  24 /**
  25  * UpLoad:  Allow Administrator to upload files to a special directory,
  26  *          which should preferably be added to the InterWikiMap
  27  * Usage:   <?plugin UpLoad ?>
  28  * Author:  NathanGass <gass@iogram.ch>
  29  * Changes: ReiniUrban <rurban@x-ray.at>,
  30  *          qubit <rtryon@dartmouth.edu>
  31  * Note:    See also Jochen Kalmbach's plugin/UserFileManagement.php
  32  */
  33
  34 class WikiPlugin_UpLoad
  35 extends WikiPlugin
  36 {
  37     var $disallowed_extensions;
  38     // TODO: use PagePerms instead
  39     var $only_authenticated = true; // allow only authenticated users may upload.
  40
  41     function getName () {
  42         return "UpLoad";
  43     }
  44
  45     function getDescription () {
  46         return _("Upload files to the local InterWiki Upload:<filename>");
  47     }
  48
  49     function getDefaultArguments() {
  50         return array('logfile'  => 'phpwiki-upload.log',
  51                      // add a link of the fresh file automatically to the
  52                      // end of the page (or current page)
  53                      'autolink' => true,
  54                      'page'     => '[pagename]',
  55                      );
  56     }
  57
  58     function run($dbi, $argstr, &$request, $basepage) {
  59         $this->disallowed_extensions = explode("\n",
  60 "ad[ep]
  61 asd
  62 ba[st]
  63 chm
  64 cmd
  65 com
  66 cgi
  67 cpl
  68 crt
  69 dll
  70 eml
  71 exe
  72 hlp
  73 hta
  74 in[fs]
  75 isp
  76 jse?
  77 lnk
  78 md[betw]
  79 ms[cipt]
  80 nws
  81 ocx
  82 ops
  83 pcd
  84 p[ir]f
  85 php
  86 pl
  87 py
  88 reg
  89 sc[frt]
  90 sh[bsm]?
  91 swf
  92 url
  93 vb[esx]?
  94 vxd
  95 ws[cfh]");
  96         //removed "\{[[:xdigit:]]{8}(?:-[[:xdigit:]]{4}){3}-[[:xdigit:]]{12}\}"
  97
  98         $args = $this->getArgs($argstr, $request);
  99         extract($args);
 100
 101         $file_dir = getUploadFilePath();
 102         //$url_prefix = SERVER_NAME . DATA_PATH;
 103
 104         $form = HTML::form(array('action' => $request->getPostURL(),
 105                                  'enctype' => 'multipart/form-data',
 106                                  'method' => 'post'));
 107         $contents = HTML::div(array('class' => 'wikiaction'));
 108         $contents->pushContent(HTML::input(array('type' => 'hidden',
 109                                                  'name' => 'MAX_FILE_SIZE',
 110                                                  'value' => MAX_UPLOAD_SIZE)));
 111         $contents->pushContent(HTML::input(array('name' => 'userfile',
 112                                                  'type' => 'file',
 113                                                  'size' => '50')));
 114         $contents->pushContent(HTML::raw(" "));
 115         $contents->pushContent(HTML::input(array('value' => _("Upload"),
 116                                                  'type' => 'submit')));
 117         $form->pushContent($contents);
 118
 119         $message = HTML();
 120         $userfile = $request->getUploadedFile('userfile');
 121         if ($userfile) {
 122             $userfile_name = $userfile->getName();
 123             $userfile_name = trim(basename($userfile_name));
 124             $userfile_tmpname = $userfile->getTmpName();
 125
 126             if ($this->only_authenticated) {
 127                 // Make sure that the user is logged in.
 128                 //
 129                 $user = $request->getUser();
 130                 if (!$user->isAuthenticated()) {
 131                     $message->pushContent(_("ACCESS DENIED: You must log in to upload files."),
 132                                           HTML::br(),HTML::br());
 133                     $result = HTML();
 134                     $result->pushContent($form);
 135                     $result->pushContent($message);
 136                     return $result;
 137                 }
 138             }
 139
 140             if (preg_match("/(\." . join("|\.", $this->disallowed_extensions) . ")\$/",
 141                            $userfile_name))
 142             {
 143                 $message->pushContent(fmt("ERROR uploading '%s': ",$userfile_name));
 144                 $message->pushContent(fmt("Files with extension %s are not allowed.",
 145                                           join(", ", $this->disallowed_extensions)),HTML::br(),HTML::br());
 146             }
 147             elseif (preg_match("/[^._a-zA-Z0-9-]/", $userfile_name))
 148             {
 149                 $message->pushContent(fmt("ERROR uploading '%s': ",$userfile_name));
 150                 $message->pushContent(_("File names may only contain alphanumeric characters and dot, underscore or dash."),
 151                                       HTML::br(),HTML::br());
 152             }
 153             elseif (file_exists($file_dir . $userfile_name)) {
 154                 $message->pushContent(fmt("ERROR uploading '%s': ",$userfile_name));
 155                 $message->pushContent(fmt("There is already a file with name %s uploaded.",
 156                                           $userfile_name),HTML::br(),HTML::br());
 157             }
 158             elseif ($userfile->getSize() > (MAX_UPLOAD_SIZE)) {
 159                 $message->pushContent(fmt("ERROR uploading '%s': ",$userfile_name));
 160                 $message->pushContent(_("Sorry but this file is too big."),HTML::br(),HTML::br());
 161             }
 162             elseif (move_uploaded_file($userfile_tmpname, $file_dir . $userfile_name) or
 163                     (IsWindows() and rename($userfile_tmpname, $file_dir . $userfile_name))
 164                     )
 165             {
 166                 $interwiki = new PageType_interwikimap();
 167                 $link = $interwiki->link("Upload:$userfile_name");
 168                 $message->pushContent(_("File successfully uploaded."));
 169                 $message->pushContent(HTML::ul(HTML::li($link)));
 170
 171                 // the upload was a success and we need to mark this event in the "upload log"
 172                 if ($logfile) {
 173                     $upload_log = $file_dir . basename($logfile);
 174                     $this->log($userfile, $upload_log, $message);
 175                 }
 176                 if ($autolink) {
 177                     require_once("lib/loadsave.php");
 178                     $pagehandle = $dbi->getPage($page);
 179                     if ($pagehandle->exists()) {// don't replace default contents
 180                         $current = $pagehandle->getCurrentRevision();
 181                         $version = $current->getVersion();
 182                         $text = $current->getPackedContent();
 183                         $newtext = $text . "\n* [Upload:$userfile_name]";
 184                         $meta = $current->_data;
 185                         $meta['summary'] = sprintf(_("uploaded %s"),$userfile_name);
 186                         $pagehandle->save($newtext, $version + 1, $meta);
 187                     }
 188                 }
 189             }
 190             else {
 191                 $message->pushContent(fmt("ERROR uploading '%s': ",$userfile_name));
 192                 $message->pushContent(HTML::br(),_("Uploading failed."),HTML::br());
 193             }
 194         }
 195         else {
 196             $message->pushContent(HTML::br(),HTML::br());
 197         }
 198
 199         //$result = HTML::div( array( 'class' => 'wikiaction' ) );
 200         $result = HTML();
 201         $result->pushContent($form);
 202         $result->pushContent($message);
 203         return $result;
 204     }
 205
 206     function log ($userfile, $upload_log, &$message) {
 207         global $WikiTheme;
 208         $user = $GLOBALS['request']->_user;
 209         if (!is_writable($upload_log)) {
 210             $message->pushContent(_("Error: the upload log is not writable."));
 211             $message->pushContent(HTML::br());
 212         }
 213         elseif (!$log_handle = fopen ($upload_log, "a")) {
 214             $message->pushContent(_("Error: can't open the upload logfile."));
 215             $message->pushContent(HTML::br());
 216         }
 217         else {        // file size in KB; precision of 0.1
 218             $file_size = round(($userfile->getSize())/1024, 1);
 219             if ($file_size <= 0) {
 220                 $file_size = "&lt; 0.1";
 221             }
 222             $userfile_name = $userfile->getName();
 223             fwrite($log_handle,
 224                    "\n"
 225                    . "<tr><td><a href=\"$userfile_name\">$userfile_name</a></td>"
 226                    . "<td align=\"right\">$file_size kB</td>"
 227                    . "<td>&nbsp;&nbsp;" . $WikiTheme->formatDate(time()) . "</td>"
 228                    . "<td>&nbsp;&nbsp;<em>" . $user->getId() . "</em></td></tr>");
 229             fclose($log_handle);
 230         }
 231         return;
 232     }
 233
 234 }
 235
 236 // $Log: not supported by cvs2svn $
 237 // Revision 1.17  2004/11/09 08:15:50  rurban
 238 // trim filename
 239 //
 240 // Revision 1.16  2004/10/21 19:03:37  rurban
 241 // Be more stricter with uploads: Filenames may only contain alphanumeric
 242 // characters. Patch #1037825
 243 //
 244 // Revision 1.15  2004/09/22 13:46:26  rurban
 245 // centralize upload paths.
 246 // major WikiPluginCached feature enhancement:
 247 //   support _STATIC pages in uploads/ instead of dynamic getimg.php? subrequests.
 248 //   mainly for debugging, cache problems and action=pdf
 249 //
 250 // Revision 1.14  2004/06/16 10:38:59  rurban
 251 // Disallow refernces in calls if the declaration is a reference
 252 // ("allow_call_time_pass_reference clean").
 253 //   PhpWiki is now allow_call_time_pass_reference = Off clean,
 254 //   but several external libraries may not.
 255 //   In detail these libs look to be affected (not tested):
 256 //   * Pear_DB odbc
 257 //   * adodb oracle
 258 //
 259 // Revision 1.13  2004/06/14 11:31:39  rurban
 260 // renamed global $Theme to $WikiTheme (gforge nameclash)
 261 // inherit PageList default options from PageList
 262 //   default sortby=pagename
 263 // use options in PageList_Selectable (limit, sortby, ...)
 264 // added action revert, with button at action=diff
 265 // added option regex to WikiAdminSearchReplace
 266 //
 267 // Revision 1.12  2004/06/13 11:34:22  rurban
 268 // fixed bug #969532 (space in uploaded filenames)
 269 // improved upload error messages
 270 //
 271 // Revision 1.11  2004/06/11 09:07:30  rurban
 272 // support theme-specific LinkIconAttr: front or after or none
 273 //
 274 // Revision 1.10  2004/04/12 10:19:18  rurban
 275 // fixed copyright year
 276 //
 277 // Revision 1.9  2004/04/12 10:18:22  rurban
 278 // removed the hairy regex line
 279 //
 280 // Revision 1.8  2004/04/12 09:12:22  rurban
 281 // fix syntax errors
 282 //
 283 // Revision 1.7  2004/04/09 17:49:03  rurban
 284 // Added PhpWiki RssFeed to Sidebar
 285 // sidebar formatting
 286 // some browser dependant fixes (old-browser support)
 287 //
 288 // Revision 1.6  2004/02/27 01:36:51  rurban
 289 // autolink enabled
 290 //
 291 // Revision 1.5  2004/02/27 01:24:43  rurban
 292 // use IntwerWiki links for uploaded file.
 293 // autolink to page prepared, but not yet ready
 294 //
 295 // Revision 1.4  2004/02/21 19:12:59  rurban
 296 // patch by Sascha Carlin
 297 //
 298 // Revision 1.3  2004/02/17 12:11:36  rurban
 299 // added missing 4th basepage arg at plugin->run() to almost all plugins. This caused no harm so far, because it was silently dropped on normal usage. However on plugin internal ->run invocations it failed. (InterWikiSearch, IncludeSiteMap, ...)
 300 //
 301 // Revision 1.2  2004/01/26 09:18:00  rurban
 302 // * changed stored pref representation as before.
 303 //   the array of objects is 1) bigger and 2)
 304 //   less portable. If we would import packed pref
 305 //   objects and the object definition was changed, PHP would fail.
 306 //   This doesn't happen with an simple array of non-default values.
 307 // * use $prefs->retrieve and $prefs->store methods, where retrieve
 308 //   understands the interim format of array of objects also.
 309 // * simplified $prefs->get() and fixed $prefs->set()
 310 // * added $user->_userid and class '_WikiUser' portability functions
 311 // * fixed $user object ->_level upgrading, mostly using sessions.
 312 //   this fixes yesterdays problems with loosing authorization level.
 313 // * fixed WikiUserNew::checkPass to return the _level
 314 // * fixed WikiUserNew::isSignedIn
 315 // * added explodePageList to class PageList, support sortby arg
 316 // * fixed UserPreferences for WikiUserNew
 317 // * fixed WikiPlugin for empty defaults array
 318 // * UnfoldSubpages: added pagename arg, renamed pages arg,
 319 //   removed sort arg, support sortby arg
 320 //
 321 // Revision 1.1  2003/11/04 18:41:41  carstenklapp
 322 // New plugin which was submitted to the mailing list some time
 323 // ago. (This is the best UpLoad function I have seen for PhpWiki so
 324 // far. Cleaned up text formatting and typos from the version on the
 325 // mailing list. Still needs a few adjustments.)
 326
 327 // (c-file-style: "gnu")
 328 // Local Variables:
 329 // mode: php
 330 // tab-width: 8
 331 // c-basic-offset: 4
 332 // c-hanging-comment-ender-p: nil
 333 // indent-tabs-mode: nil
 334 // End:
 335 ?>