config/Values.php

   1 <?php
   2 rcs_id('$Id: Values.php,v 1.7 2004-04-21 05:21:17 zorloc Exp $');
   3 /*
   4  Copyright 2002 $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 * This is the master array that holds all of the configuration
  25 * values.
  26 */
  27 $values = array();
  28
  29 /*
  30 This is a template for a constant or variable value.
  31
  32 $values[] = array(
  33     'type' => '',
  34     'name' => '',
  35     'section' => ,
  36     'defaultValue' => ,
  37     'hide' => ,
  38     'description' => array(
  39         'short' => '',
  40         'full' => ''
  41     ),
  42     'example' => array(
  43     ),
  44     'validator' => array(
  45         'type' => ''
  46     )
  47 );
  48 */
  49
  50 /**
  51 * Define the include path if necessary.
  52 */
  53 $values[] = array(
  54     'type' => 'Ini',
  55     'name' => 'INCLUDE_PATH',
  56     'section' => 0,
  57     'defaultValue' => null,
  58     'hide' => true,
  59     'description' => array(
  60         'short' => 'Redefine the php.ini \'include_path\' setting.',
  61         'full' => 'If PHP needs help in finding where you installed the rest ' .
  62                   'of the PhpWiki code, you can set the include_path here.\n\n' .
  63                   'You should not need to do this unless you have moved index.php ' .
  64                   'out of the PhpWiki install directory.\n\n' .
  65                   'NOTE: On Windows installations a semicolon (;) should be used ' .
  66                   'as the path seperator'
  67     ),
  68     'example' => array(
  69         '.:/usr/local/httpd/htdocs/phpwiki'
  70     ),
  71     'validator' => array(
  72         'type' => 'String'
  73     )
  74 );
  75
  76 /**
  77 * Enable debuging output
  78 */
  79 $values[] = array(
  80     'type' => 'Constant',
  81     'name' => 'DEBUG',
  82     'section' => 0,
  83     'defaultValue' => false,
  84     'hide' => true,
  85     'description' => array(
  86         'short' => 'Enable Debug Output',
  87         'full' => 'Set DEBUG to \'true\' to view XHMTL and CSS validator icons, page ' .
  88                   'process timer, and possibly other debugging messages at the ' .
  89                   'bottom of each page'
  90     ),
  91     'example' => array(
  92     ),
  93     'validator' => array(
  94         'type' => 'Boolean'
  95     )
  96 );
  97
  98 /**
  99 * Enable Experimental User Classes
 100 */
 101 $values[] = array(
 102     'type' => 'Constant',
 103     'name' => 'ENABLE_USER_NEW',
 104     'section' => 0,
 105     'defaultValue' => true,
 106     'hide' => false,
 107     'description' => array(
 108         'short' => 'Enable Experimental User Classes',
 109         'full' => 'Enable the new method of handling WikiUsers.  This is currently an ' .
 110                   'experimental feature, although it is considered fairly stable.  It is ' .
 111                   'best to leave it on, and only disable it if you have problems with it.'
 112     ),
 113     'example' => array(
 114     ),
 115     'validator' => array(
 116         'type' => 'Boolean'
 117     )
 118 );
 119
 120 /**
 121 * Experimental edit feature
 122 */
 123 $values[] = array(
 124     'type' => 'Constant',
 125     'name' => 'JS_SEARCHREPLACE',
 126     'section' => 0,
 127     'defaultValue' => false,
 128     'description' => array(
 129         'short' => 'Enable Experimental Edit Feature',
 130         'full' => ''
 131     ),
 132     'example' => array(
 133     ),
 134     'validator' => array(
 135         'type' => 'Boolean'
 136     )
 137 );
 138
 139
 140
 141 /**
 142 * This defines the Constant that holds the name of the wiki
 143 */
 144 $values[] = array(
 145     'type' => 'Constant',
 146     'name' => 'WIKI_NAME',
 147     'section' => 1,
 148     'defaultValue' => 'PhpWiki',
 149     'hide' => false,
 150     'description' => array(
 151         'short' => 'Name of your Wiki.',
 152         'full' => 'This can be any string, but it should be short and informative.'
 153     ),
 154     'example' => array(
 155     ),
 156     'validator' => array(
 157         'type' => 'String'
 158     )
 159 );
 160
 161 $values[] = array(
 162     'type' => 'Constant',
 163     'name' => 'ENABLE_REVERSE_DNS',
 164     'section' => 1,
 165     'defaultValue' => false,
 166     'hide' => false,
 167     'description' => array(
 168         'short' => 'Perform reverse DNS lookups',
 169         'full' => 'If set, we will perform reverse dns lookups to try to convert ' .
 170                   'the users IP number to a host name, even if the http server ' .
 171                   'didn\'t do it for us.'
 172     ),
 173     'example' => array(
 174     ),
 175     'validator' => array(
 176         'type' => 'Boolean'
 177     )
 178 );
 179
 180 $values[] = array(
 181     'type' => 'Constant',
 182     'name' => 'ADMIN_USER',
 183     'section' => 1,
 184     'defaultValue' => "",
 185     'hide' => true,
 186     'description' => array(
 187         'short' => 'Username of Administrator',
 188         'full' => 'The username of the Administrator can be just about any string.'
 189     ),
 190     'example' => array(
 191     ),
 192     'validator' => array(
 193         'type' => 'String'
 194     )
 195 );
 196
 197 $values[] = array(
 198     'type' => 'Constant',
 199     'name' => 'ADMIN_PASSWD',
 200     'section' => 1,
 201     'defaultValue' => "",
 202     'hide' => true,
 203     'description' => array(
 204         'short' => 'Password of Administrator',
 205         'full' => 'The password of the Administrator, please use a secure password.'
 206     ),
 207     'example' => array(
 208     ),
 209     'validator' => array(
 210         'type' => 'String'
 211     )
 212 );
 213
 214 $values[] = array(
 215     'type' => 'Constant',
 216     'name' => 'ENCRYPTED_PASSWD',
 217     'section' => 1,
 218     'defaultValue' => true,
 219     'hide' => false,
 220     'description' => array(
 221         'short' => 'Encrypt Administrator Password.',
 222         'full' => 'True if the Administrator password is encrypted using the embeded tool.'
 223     ),
 224     'example' => array(
 225     ),
 226     'validator' => array(
 227         'type' => 'Boolean'
 228     )
 229 );
 230
 231 $values[] = array(
 232     'type' => 'Constant',
 233     'name' => 'ZIPDUMP_AUTH',
 234     'section' => 1,
 235     'defaultValue' => true,
 236     'hide' => false,
 237     'description' => array(
 238         'short' => 'Require privilage to make zip dumps.',
 239         'full' => 'If true then only the Administrator will be allowed to make a zipped ' .
 240                   'archive of the Wiki.'
 241     ),
 242     'validator' => array(
 243         'type' => 'Boolean'
 244     )
 245 );
 246
 247 $values[] = array(
 248     'type' => 'Constant',
 249     'name' => 'ENABLE_RAW_HTML',
 250     'section' => 1,
 251     'defaultValue' => false,
 252     'hide' => false,
 253     'description' => array(
 254         'short' => 'Enable the use of html in a WikiPage',
 255         'full' => 'If true raw html will be respected in the markup of a WikiPage. ' .
 256                   '*WARNING*: this is a major security hole! Do not enable on a public ' .
 257                   'Wiki.'
 258     ),
 259     'example' => array(
 260     ),
 261     'validator' => array(
 262         'type' => 'Boolean'
 263     )
 264 );
 265
 266 $values[] = array(
 267     'type' => 'Constant',
 268     'name' => 'STRICT_MAILABLE_PAGEDUMPS',
 269     'section' => 1,
 270     'defaultValue' => false,
 271     'hide' => false,
 272     'description' => array(
 273         'short' => 'Page dumps are valid RFC 2822 e-mail messages',
 274         'full' => 'If you define this to true, (MIME-type) page-dumps (either zip ' .
 275                   'dumps, or "dumps to directory" will be encoded using the ' .
 276                   'quoted-printable encoding.  If you\'re actually thinking of ' .
 277                   'mailing the raw page dumps, then this might be useful, since ' .
 278                   '(among other things,) it ensures that all lines in the message ' .
 279                   'body are under 80 characters in length. Also, setting this will ' .
 280                   'cause a few additional mail headers to be generated, so that the ' .
 281                   'resulting dumps are valid RFC 2822 e-mail messages. Probably, you ' .
 282                   'can just leave this set to false, in which case you get raw ' .
 283                   '(\'binary\' content-encoding) page dumps.'
 284     ),
 285     'example' => array(
 286     ),
 287     'validator' => array(
 288         'type' => 'Boolean'
 289     )
 290 );
 291
 292 $values[] = array(
 293     'type' => 'Constant',
 294     'name' => 'HTML_DUMP_SUFFIX',
 295     'section' => 1,
 296     'defaultValue' => '.html',
 297     'hide' => false,
 298     'description' => array(
 299         'short' => 'Suffix for XHTML page dumps',
 300         'full' => 'This suffix will be appended to the name of each page for a ' .
 301                   'XHTML page dump and the page links will be modified accordingly.'
 302     ),
 303     'example' => array(
 304         '.xml',
 305         '.htm'
 306     ),
 307     'validator' => array(
 308         'type' => 'String'
 309     )
 310 );
 311
 312 $values[] = array(
 313     'type' => 'Constant',
 314     'name' => 'MAX_UPLOAD_SIZE',
 315     'section' => 1,
 316     'defaultValue' => (16 * 1024 * 1024),  // 16MB
 317     'hide' => false,
 318     'description' => array(
 319         'short' => 'Maximum file upload size',
 320         'full' => 'The maximum file upload size in bytes.'
 321     ),
 322     'example' => array(
 323     ),
 324     'validator' => array(
 325         'type' => 'Integer'
 326     )
 327 );
 328
 329 $values[] = array(
 330     'type' => 'Constant',
 331     'name' => 'MINOR_EDIT_TIMEOUT',
 332     'section' => 1,
 333     'defaultValue' => (7 * 24 * 60 * 60), // One week
 334     'hide' => false,
 335     'description' => array(
 336         'short' => 'Length of time where \'Minor Edit\' is default',
 337         'full' => 'If an edit is started less than this period of time from the ' .
 338                   'prior edit, the \'Minor Edit\' checkbox will be set.'
 339     ),
 340     'example' => array(
 341     ),
 342     'validator' => array(
 343         'type' => 'Integer'
 344     )
 345 );
 346
 347 $values[] = array(
 348     'type' => 'Variable',
 349     'name' => 'DisabledActions',
 350     'section' => 1,
 351     'defaultValue' => '',
 352     'hide' => true,
 353     'description' => array(
 354         'short' => 'List of actions to disable',
 355         'full' => 'Each action listed will be disabled.'
 356     ),
 357     'example' => array(
 358         'dumpserial : loadfile',
 359         'remove : dumpserial : loadfile : upload'
 360     ),
 361     'validator' => array(
 362         'type' => 'ArrayString',
 363         'seperator' => ':',
 364         'list' => array(
 365             'browse',
 366             'verify',
 367             'diff',
 368             'search',
 369             'edit',
 370             'viewsource',
 371             'lock',
 372             'unlock',
 373             'remove',
 374             'upload',
 375             'xmlrpc',
 376             'zip',
 377             'ziphtml',
 378             'dumpserial',
 379             'dumphtml',
 380             'loadfile'
 381         )
 382     )
 383 );
 384
 385 $values[] = array(
 386     'type' => 'Constant',
 387     'name' => 'ACCESS_LOG',
 388     'section' => 1,
 389     'defaultValue' => '',
 390     'hide' => true,
 391     'description' => array(
 392         'short' => 'Enable and location of Wiki Access Log',
 393         'full' => 'PhpWiki can generate an access_log (in NCSA combined log ' .
 394                   'format) for you.  If you want one, define location for the ' .
 395                   'file.  The server must have write access for the specified ' .
 396                   'location.'
 397     ),
 398     'example' => array(
 399         '/var/tmp/wiki_access_log',
 400         '/tmp/phpwiki_log'
 401     ),
 402     'validator' => array(
 403         'type' => 'String'
 404     )
 405 );
 406
 407 $values[] = array(
 408     'type' => 'Constant',
 409     'name' => 'COMPRESS_OUTPUT',
 410     'section' => 1,
 411     'defaultValue' => false,
 412     'hide' => true,
 413     'description' => array(
 414         'short' => 'Enable Ouput Compression',
 415         'full' => 'By default PhpWiki will try to have PHP compress ' .
 416                   'its output before sending it to the browser (if you ' .
 417                   'have a recent enough version of PHP and the browser ' .
 418                   'supports it).\n' .
 419                   'Define COMPRESS_OUTPUT to false to prevent output compression.\n' .
 420                   'Define COMPRESS_OUTPUT to true to force output compression.\n' .
 421                   'Leave undefined to leave the choice up to PhpWiki.\n' .
 422                   'WARNING: Compressing the output has been reported to cause ' .
 423                   'serious problems when PHP is running as a CGI.'
 424     ),
 425     'example' => array(
 426         'false'
 427     ),
 428     'validator' => array(
 429         'type' => 'Boolean'
 430     )
 431 );
 432
 433
 434 $values[] = array(
 435     'type' => 'Constant',
 436     'name' => 'CACHE_CONTROL',
 437     'section' => 1,
 438     'defaultValue' => 'LOOSE',
 439     'hide' => false,
 440     'description' => array(
 441         'short' => 'HTTP Cache Control Behavior',
 442         'full' => 'Choose one of:\n\n' .
 443                   'NONE: PhpWiki will instruct proxies and browsers never to ' .
 444                   'cache PhpWiki output.  This is roughly pre-1.3.4 behavior.\n\n' .
 445                   'STRICT: Cached pages will be invalidated whenever the database ' .
 446                   'global timestamp changes.  This should be slightly more ' .
 447                   'efficient than NONE.\n\n' .
 448                   'LOOSE: Cached pages will be invalidated whenever they are ' .
 449                   'edited, or, if the pages include plugins, when the plugin ' .
 450                   'output could concievably have changed.  This might result ' .
 451                   'in wikilinks that show up as undefined even though the page ' .
 452                   'has been (recently) created.\n\n' .
 453                   'ALLOW_STALE: Invalidation will be defined by ' .
 454                   'CACHE_CONTROL_MAX_AGE, allowing browsers and proxies to ' .
 455                   'display stale pages.  This will result in very quirky ' .
 456                   'behavior.  This setting is generally not advisable.\n\n' .
 457                   'The recommended default is LOOSE.'
 458     ),
 459     'example' => array(
 460     ),
 461     'validator' => array(
 462         'type' => 'String',
 463         'list' => array(
 464             'NONE',
 465             'STRICT',
 466             'LOOSE',
 467             'ALLOW_STALE'
 468         )
 469     )
 470 );
 471
 472 $values[] = array(
 473     'type' => 'Constant',
 474     'name' => 'CACHE_CONTROL_MAX_AGE',
 475     'section' => 1,
 476     'defaultValue' => 600,
 477     'hide' => false,
 478     'description' => array(
 479         'short' => 'Maximum Page Staleness',
 480         'full' => 'The maximum time in seconds proxies and browsers should ' .
 481                   'cache pages.  This setting is relevant only if CACHE_CONTROL ' .
 482                   'is set to ALLOW_STALE.'
 483     ),
 484     'example' => array(
 485     ),
 486     'validator' => array(
 487         'type' => 'Integer'
 488     )
 489 );
 490
 491 $values[] = array(
 492     'type' => 'Constant',
 493     'name' => 'WIKIDB_NOCACHE_MARKUP',
 494     'section' => 1,
 495     'defaultValue' => false,
 496     'hide' => true,
 497     'description' => array(
 498         'short' => 'Disable Caching of Page Markup',
 499         'full' => 'PhpWiki normally caches a preparsed version of the most recent ' .
 500                   'version of each page. Define this setting to true to disable ' .
 501                   'the caching of marked-up page content.\n\n' .
 502                   'NOTE: You can also disable markup cacheing on a per-page ' .
 503                   'temporary basis by adding a query arg of \'?nocache=1\' ' .
 504                   'to the URL to the page, or \'?nocache=purge\' to completely ' .
 505                   'discard the cached version of the page.  Additionally via the ' .
 506                   '"Purge Markup Cache" button on the PhpWikiAdministration page, ' .
 507                   'you can purged the cached markup globally.'
 508     ),
 509     'example' => array(
 510     ),
 511     'validator' => array(
 512         'type' => 'Boolean'
 513     )
 514 );
 515
 516 //$Log: not supported by cvs2svn $
 517 //Revision 1.5  2004/04/21 00:15:24  zorloc
 518 //Added Section 0 values
 519 //
 520 //Revision 1.4  2003/12/07 19:25:41  carstenklapp
 521 //Code Housecleaning: fixed syntax errors. (php -l *.php)
 522 //
 523 //Revision 1.2  2003/01/28 18:55:25  zorloc
 524 //I have added all of the values for Part One of our configuration values.
 525 //
 526 //Revision 1.1  2003/01/28 07:32:24  zorloc
 527 //This file holds all of the config settings for the constants, variables,
 528 //and arrays that can be customized/defined.
 529 //
 530 //I have done a template and one constant (WIKI_NAME).  More to follow.
 531 //
 532
 533 // Local Variables:
 534 // mode: php
 535 // tab-width: 8
 536 // c-basic-offset: 4
 537 // c-hanging-comment-ender-p: nil
 538 // indent-tabs-mode: nil
 539 // End:
 540
 541 ?>