OSDN Git Service

Corrected / Added comments only
[pukiwiki/pukiwiki.git] / pukiwiki.ini.php
1 <?php
2 // PukiWiki - Yet another WikiWikiWeb clone
3 // $Id: pukiwiki.ini.php,v 1.116 2005/03/21 08:29:18 henoheno Exp $
4 //
5 // PukiWiki main setting file
6
7 /////////////////////////////////////////////////
8 // Functionality settings
9
10 // PKWK_OPTIMISE - Ignore verbose but understandable checking and warning
11 //   If you end testing this PukiWiki, set '1'.
12 //   If you feel in trouble about this PukiWiki, set '0'.
13 if (! defined('PKWK_OPTIMISE'))
14         define('PKWK_OPTIMISE', 0);
15
16 /////////////////////////////////////////////////
17 // Security settings
18
19 // PKWK_READONLY - Prohibits editing and maintain via WWW
20 //   NOTE: Counter-related functions will work now (counter, attach count, etc)
21 if (! defined('PKWK_READONLY'))
22         define('PKWK_READONLY', 0); // 0 or 1
23
24 // PKWK_SAFE_MODE - Prohibits some unsafe(but compatible) functions 
25 if (! defined('PKWK_SAFE_MODE'))
26         define('PKWK_SAFE_MODE', 0);
27
28 // PKWK_QUERY_STRING_MAX
29 //   Max length of GET method, prohibits some worm attack ASAP
30 //   NOTE: Keep (page-name + attach-file-name) <= PKWK_QUERY_STRING_MAX
31 define('PKWK_QUERY_STRING_MAX', 640); // Bytes, 0 = OFF
32
33 /////////////////////////////////////////////////
34 // Language / Encoding settings
35
36 // LANG - Internal content encoding ('en', 'ja', or ...)
37 define('LANG', 'ja');
38
39 // UI_LANG - Content encoding for buttons, menus,  etc
40 define('UI_LANG', LANG); // 'en' for Internationalized wikisite
41
42 /////////////////////////////////////////////////
43 // Directory settings I (ended with '/', permission '777')
44
45 // You may hide these directories (from web browsers)
46 // by setting DATA_HOME at index.php.
47
48 define('DATA_DIR',      DATA_HOME . 'wiki/'     ); // Latest wiki texts
49 define('DIFF_DIR',      DATA_HOME . 'diff/'     ); // Latest diffs
50 define('BACKUP_DIR',    DATA_HOME . 'backup/'   ); // Backups
51 define('CACHE_DIR',     DATA_HOME . 'cache/'    ); // Some sort of caches
52 define('UPLOAD_DIR',    DATA_HOME . 'attach/'   ); // Attached files and logs
53 define('COUNTER_DIR',   DATA_HOME . 'counter/'  ); // Counter plugin's counts
54 define('TRACKBACK_DIR', DATA_HOME . 'trackback/'); // TrackBack logs
55 define('PLUGIN_DIR',    DATA_HOME . 'plugin/'   ); // Plugin directory
56
57 /////////////////////////////////////////////////
58 // Directory settings II (ended with '/')
59
60 // Skins / Stylesheets
61 define('SKIN_DIR', 'skin/');
62 // Skin files (SKIN_DIR/*.skin.php) are needed at
63 // ./DATAHOME/SKIN_DIR from index.php, but
64 // CSSs(*.css) and JavaScripts(*.js) are needed at
65 // ./SKIN_DIR from index.php.
66
67 // Static image files
68 define('IMAGE_DIR', 'image/');
69 // Keep this directory shown via web browsers like
70 // ./IMAGE_DIR from index.php.
71
72 /////////////////////////////////////////////////
73 // Local time setting
74
75 switch (LANG) { // or specifiy one
76 case 'ja':
77         define('ZONE', 'JST');
78         define('ZONETIME', 9 * 3600); // JST = GMT + 9
79         break;
80 default  :
81         define('ZONE', 'GMT');
82         define('ZONETIME', 0);
83         break;
84 }
85
86 /////////////////////////////////////////////////
87 // Title of your Wikisite (Name this)
88 // Also used as RSS feed's channel name etc
89 $page_title = 'PukiWiki';
90
91 // Specify PukiWiki URL (default: auto)
92 //$script = 'http://example.com/pukiwiki/';
93
94 // Shorten $script: Cut its file name (default: not cut)
95 //$script_directory_index = 'index.php';
96
97 // Site admin's name (CHANGE THIS)
98 $modifier = 'anonymous';
99
100 // Site admin's Web page (CHANGE THIS)
101 $modifierlink = 'http://pukiwiki.example.com/';
102
103 // Default page name
104 $defaultpage  = 'FrontPage';     // Top / Default page
105 $whatsnew     = 'RecentChanges'; // Modified page list
106 $whatsdeleted = 'RecentDeleted'; // Removeed page list
107 $interwiki    = 'InterWikiName'; // Set InterWiki definition here
108 $menubar      = 'MenuBar';       // Menu
109
110 /////////////////////////////////////////////////
111 // Change default Document Type Definition
112
113 // Some web browser's bug, and / or Java apprets may needs not-Strict DTD.
114 // Some plugin (e.g. paint) set this PKWK_DTD_XHTML_1_0_TRANSITIONAL.
115
116 //$pkwk_dtd = PKWK_DTD_XHTML_1_1; // Default
117 //$pkwk_dtd = PKWK_DTD_XHTML_1_0_STRICT;
118 //$pkwk_dtd = PKWK_DTD_XHTML_1_0_TRANSITIONAL;
119 //$pkwk_dtd = PKWK_DTD_HTML_4_01_STRICT;
120 //$pkwk_dtd = PKWK_DTD_HTML_4_01_TRANSITIONAL;
121
122 /////////////////////////////////////////////////
123
124 // PKWK_ALLOW_JAVASCRIPT - Allow / Prohibit using JavaScript
125 define('PKWK_ALLOW_JAVASCRIPT', 0);
126
127 /////////////////////////////////////////////////
128 // TrackBack feature
129
130 // Enable Trackback
131 $trackback = 0;
132
133 // Show trackbacks with an another window (using JavaScript)
134 $trackback_javascript = 0;
135
136 /////////////////////////////////////////////////
137 // Referer list feature
138 $referer = 0;
139
140 /////////////////////////////////////////////////
141 // _Disable_ WikiName auto-linking
142 $nowikiname = 0;
143
144 /////////////////////////////////////////////////
145 // AutoLink feature
146
147 // AutoLink minimum length of page name
148 $autolink = 8; // Bytes, 0 = OFF
149
150 /////////////////////////////////////////////////
151 // Enable Freeze / Unfreeze feature
152 $function_freeze = 1;
153
154 /////////////////////////////////////////////////
155 // Enable 'Do not change timestamp' at edit
156 // (1:Enable, 2:Enable only administrator, 0:Disable)
157 $notimeupdate = 1;
158
159 /////////////////////////////////////////////////
160 // Admin password for this Wikisite
161
162 // CHANGE THIS
163 $adminpass = '1a1dc91c907325c69271ddf0c944bc72'; // md5('pass')
164
165 /////////////////////////////////////////////////
166 // Page-reading feature settings
167 // (Automatically creating pronounce datas, for Kanji-included page names,
168 //  to show sorted page-list correctly)
169
170 // Enable page-reading feature by calling ChaSen or KAKASHI command
171 // (1:Enable, 0:Disable)
172 $pagereading_enable = 0;
173
174 // Specify converter as ChaSen('chasen') or KAKASI('kakasi') or None('none')
175 $pagereading_kanji2kana_converter = 'none';
176
177 // Specify Kanji encoding to pass data between PukiWiki and the converter
178 $pagereading_kanji2kana_encoding = 'EUC'; // Default for Unix
179 //$pagereading_kanji2kana_encoding = 'SJIS'; // Default for Windows
180
181 // Absolute path of the converter (ChaSen)
182 $pagereading_chasen_path = '/usr/local/bin/chasen';
183 //$pagereading_chasen_path = 'c:\progra~1\chasen21\chasen.exe';
184
185 // Absolute path of the converter (KAKASI)
186 $pagereading_kakasi_path = '/usr/local/bin/kakasi';
187 //$pagereading_kakasi_path = 'c:\kakasi\bin\kakasi.exe';
188
189 // Page name contains pronounce data (written by the converter)
190 $pagereading_config_page = ':config/PageReading';
191
192 // Page name of default pronouncing dictionary, used when converter = 'none'
193 $pagereading_config_dict = ':config/PageReading/dict';
194
195 /////////////////////////////////////////////////
196 // User definition
197 $auth_users = array(
198         'foo'   => 'foo_passwd',
199         'bar'   => 'bar_passwd',
200         'hoge'  => 'hoge_passwd',
201 );
202
203 /////////////////////////////////////////////////
204 // Authentication method
205
206 // 'pagename' : by Page name
207 // 'contents' : by Page contents
208 $auth_method_type = 'contents';
209
210 /////////////////////////////////////////////////
211 // Read auth (0:Disable, 1:Enable)
212 $read_auth = 0;
213
214 // Read auth regex
215 $read_auth_pages = array(
216         '#¤Ò¤­¤³¤â¤ë¤Û¤²#'      => 'hoge',
217         '#(¥Í¥¿¥Ð¥ì|¤Í¤¿¤Ð¤ì)#' => 'foo,bar,hoge',
218 );
219
220 /////////////////////////////////////////////////
221 // Edit auth (0:Disable, 1:Enable)
222 $edit_auth = 0;
223
224 // Edit auth regex
225 $edit_auth_pages = array(
226         '#Bar¤Î¸ø³«Æüµ­#'       => 'bar',
227         '#¤Ò¤­¤³¤â¤ë¤Û¤²#'      => 'hoge',
228         '#(¥Í¥¿¥Ð¥ì|¤Í¤¿¤Ð¤ì)#' => 'foo,bar,hoge',
229 );
230
231 /////////////////////////////////////////////////
232 // Search auth
233 // 0: Disabled (Search read-prohibited page contents)
234 // 1: Enabled  (Search only permitted pages for the user)
235 $search_auth = 0;
236
237 /////////////////////////////////////////////////
238 // $whatsnew: Max number of RecentChanges
239 $maxshow = 60;
240
241 // $whatsdeleted: Max number of RecentDeleted
242 // (0 = Disabled)
243 $maxshow_deleted = 60;
244
245 /////////////////////////////////////////////////
246 // Page names can't be edit via PukiWiki
247 $cantedit = array( $whatsnew, $whatsdeleted );
248
249 /////////////////////////////////////////////////
250 // HTTP: Output Last-Modified header
251 $lastmod = 0;
252
253 /////////////////////////////////////////////////
254 // Date format
255 $date_format = 'Y-m-d';
256
257 // Time format
258 $time_format = 'H:i:s';
259
260 /////////////////////////////////////////////////
261 // Max number of RSS feed
262 $rss_max = 15;
263
264 /////////////////////////////////////////////////
265 // Backup related settings
266
267 // Enable backup
268 $do_backup = 1;
269
270 // When a page had been removed, remove its backup too?
271 $del_backup = 0;
272
273 // Bacukp interval and generation
274 $cycle  =   3; // Wait N hours between backup (0 = no wait)
275 $maxage = 120; // Stock latest N backups
276
277 // NOTE: $cycle x $maxage / 24 = Minimum days to lost your data
278 //          3   x   120   / 24 = 15
279
280 // Splitter of backup data (NOTE: Too dangerous to change)
281 define('PKWK_SPLITTER', '>>>>>>>>>>');
282
283 /////////////////////////////////////////////////
284 // Command executed per update
285 $update_exec = '';
286 //$update_exec = '/usr/bin/mknmz --media-type=text/pukiwiki -O /var/lib/namazu/index/ -L ja -c -K /var/www/wiki/';
287
288 /////////////////////////////////////////////////
289 // HTTP proxy setting (for TrackBack etc)
290
291 // Use HTTP proxy server to get remote data
292 $use_proxy = 0;
293
294 $proxy_host = 'proxy.example.com';
295 $proxy_port = 8080;
296
297 // Do Basic authentication
298 $need_proxy_auth = 0;
299 $proxy_auth_user = 'username';
300 $proxy_auth_pass = 'password';
301
302 // Hosts that proxy server will not be needed
303 $no_proxy = array(
304         'localhost',    // localhost
305         '127.0.0.0/8',  // loopback
306 //      '10.0.0.0/8'    // private class A
307 //      '172.16.0.0/12' // private class B
308 //      '192.168.0.0/16'        // private class C
309 //      'no-proxy.com',
310 );
311
312 ////////////////////////////////////////////////
313 // Mail related settings
314
315 // Send mail per update of pages
316 $notify = 0;
317
318 // Send diff only
319 $notify_diff_only = 1;
320
321 // SMTP server (Windows only. Usually specified at php.ini)
322 $smtp_server = 'localhost';
323
324 // Mail recipient (To:) and sender (From:)
325 $notify_to   = 'to@example.com';        // To:
326 $notify_from = 'from@example.com';      // From:
327
328 // Subject: ($page = Page name wll be replaced)
329 $notify_subject = '[PukiWiki] $page';
330
331 // Mail header
332 $notify_header = "From: $notify_from\r\n" .
333         'X-Mailer: PukiWiki/' .  S_VERSION . ' PHP/' . phpversion();
334
335 /////////////////////////////////////////////////
336 // Mail: POP / APOP Before SMTP
337
338 // Do POP/APOP authentication before send mail
339 $smtp_auth = 0;
340
341 $pop_server = 'localhost';
342 $pop_port   = 110;
343 $pop_userid = '';
344 $pop_passwd = '';
345
346 // Use APOP instead of POP (If server uses)
347 //   Default = Auto (Use APOP if possible)
348 //   1       = Always use APOP
349 //   0       = Always use POP
350 // $pop_auth_use_apop = 1;
351
352 /////////////////////////////////////////////////
353 // Ignore list
354
355 // Regex of ignore pages
356 $non_list = '^\:';
357
358 // Search ignored pages
359 $search_non_list = 1;
360
361 /////////////////////////////////////////////////
362 // Template setting
363
364 $auto_template_func = 1;
365 $auto_template_rules = array(
366         '((.+)\/([^\/]+))' => '\2/template'
367 );
368
369 /////////////////////////////////////////////////
370 // Automatically add fixed heading anchor
371 $fixed_heading_anchor = 1;
372
373 /////////////////////////////////////////////////
374 // Remove the first spaces from Preformatted text
375 $preformat_ltrim = 1;
376
377 /////////////////////////////////////////////////
378 // Convert linebreaks into <br/>
379 $line_break = 0;
380
381 /////////////////////////////////////////////////
382 // Use date-time rules (See rules.ini.php)
383 $usedatetime = 1;
384
385 /////////////////////////////////////////////////
386 // User-Agent settings
387 //
388 // If you want to ignore embedded browsers for rich-content-wikisite,
389 // remove (or comment-out) all 'keitai' settings.
390 //
391 // If you want to to ignore desktop-PC browsers for simple wikisite,
392 // copy keitai.ini.php to default.ini.php and customize it.
393
394 $agents = array(
395 // pattern: A regular-expression that matches device(browser)'s name and version
396 // profile: A group of browsers
397
398     // Embedded browsers (Rich-clients for PukiWiki)
399
400         // Windows CE (Microsoft(R) Internet Explorer 5.5 for Windows(R) CE)
401         // Sample: "Mozilla/4.0 (compatible; MSIE 5.5; Windows CE; sigmarion3)" (sigmarion, Hand-held PC)
402         array('pattern'=>'#\b(?:MSIE [5-9]).*\b(Windows CE)\b#', 'profile'=>'default'),
403
404         // ACCESS "NetFront" / "Compact NetFront" and thier OEM, expects to be "Mozilla/4.0"
405         // Sample: "Mozilla/4.0 (PS2; PlayStation BB Navigator 1.0) NetFront/3.0" (PlayStation BB Navigator, for SONY PlayStation 2)
406         // Sample: "Mozilla/4.0 (PDA; PalmOS/sony/model crdb/Revision:1.1.19) NetFront/3.0" (SONY Clie series)
407         // Sample: "Mozilla/4.0 (PDA; SL-A300/1.0,Embedix/Qtopia/1.1.0) NetFront/3.0" (SHARP Zaurus)
408         array('pattern'=>'#^(?:Mozilla/4).*\b(NetFront)/([0-9\.]+)#',   'profile'=>'default'),
409
410     // Embedded browsers (Non-rich)
411
412         // Windows CE (the others)
413         // Sample: "Mozilla/2.0 (compatible; MSIE 3.02; Windows CE; 240x320 )" (GFORT, NTT DoCoMo)
414         array('pattern'=>'#\b(Windows CE)\b#', 'profile'=>'keitai'),
415
416         // ACCESS "NetFront" / "Compact NetFront" and thier OEM
417         // Sample: "Mozilla/3.0 (AveFront/2.6)" ("SUNTAC OnlineStation", USB-Modem for PlayStation 2)
418         // Sample: "Mozilla/3.0(DDIPOCKET;JRC/AH-J3001V,AH-J3002V/1.0/0100/c50)CNF/2.0" (DDI Pocket: AirH" Phone by JRC)
419         array('pattern'=>'#\b(NetFront)/([0-9\.]+)#',   'profile'=>'keitai'),
420         array('pattern'=>'#\b(CNF)/([0-9\.]+)#',        'profile'=>'keitai'),
421         array('pattern'=>'#\b(AveFront)/([0-9\.]+)#',   'profile'=>'keitai'),
422         array('pattern'=>'#\b(AVE-Front)/([0-9\.]+)#',  'profile'=>'keitai'), // The same?
423
424         // NTT-DoCoMo, i-mode (embeded Compact NetFront) and FOMA (embedded NetFront) phones
425         // Sample: "DoCoMo/1.0/F501i", "DoCoMo/1.0/N504i/c10/TB/serXXXX" // c°Ê¹ß¤Ï²ÄÊÑ
426         // Sample: "DoCoMo/2.0 MST_v_SH2101V(c100;TB;W22H12;serXXXX;iccxxxx)" // ()¤ÎÃæ¤Ï²ÄÊÑ
427         array('pattern'=>'#^(DoCoMo)/([0-9\.]+)#',      'profile'=>'keitai'),
428
429         // Vodafone's embedded browser
430         // Sample: "J-PHONE/2.0/J-T03"  // 2.0¤Ï"¥Ö¥é¥¦¥¶¤Î"¥Ð¡¼¥¸¥ç¥ó
431         // Sample: "J-PHONE/4.0/J-SH51/SNxxxx SH/0001a Profile/MIDP-1.0 Configuration/CLDC-1.0 Ext-Profile/JSCL-1.1.0"
432         array('pattern'=>'#^(J-PHONE)/([0-9\.]+)#',     'profile'=>'keitai'),
433
434         // Openwave(R) Mobile Browser (EZweb, WAP phone, etc)
435         // Sample: "OPWV-SDK/62K UP.Browser/6.2.0.5.136 (GUI) MMP/2.0"
436         array('pattern'=>'#\b(UP\.Browser)/([0-9\.]+)#',        'profile'=>'keitai'),
437
438         // Opera, dressing up as other embedded browsers
439         // Sample: "Mozilla/3.0(DDIPOCKET;KYOCERA/AH-K3001V/1.4.1.67.000000/0.1/C100) Opera 7.0" (Like CNF at 'keitai'-mode)
440         array('pattern'=>'#\bDDIPOCKET\b.+\b(Opera) ([0-9\.]+)\b#',     'profile'=>'keitai'),
441
442         // Planetweb http://www.planetweb.com/
443         // Sample: "Mozilla/3.0 (Planetweb/v1.07 Build 141; SPS JP)" ("EGBROWSER", Web browser for PlayStation 2)
444         array('pattern'=>'#\b(Planetweb)/v([0-9\.]+)#', 'profile'=>'keitai'),
445
446         // DreamPassport, Web browser for SEGA DreamCast
447         // Sample: "Mozilla/3.0 (DreamPassport/3.0)"
448         array('pattern'=>'#\b(DreamPassport)/([0-9\.]+)#',      'profile'=>'keitai'),
449
450         // Palm "Web Pro" http://www.palmone.com/us/support/accessories/webpro/
451         // Sample: "Mozilla/4.76 [en] (PalmOS; U; WebPro)"
452         array('pattern'=>'#\b(WebPro)\b#',      'profile'=>'keitai'),
453
454         // ilinx "Palmscape" / "Xiino" http://www.ilinx.co.jp/
455         // Sample: "Xiino/2.1SJ [ja] (v. 4.1; 153x130; c16/d)"
456         array('pattern'=>'#^(Palmscape)/([0-9\.]+)#',   'profile'=>'keitai'),
457         array('pattern'=>'#^(Xiino)/([0-9\.]+)#',       'profile'=>'keitai'),
458
459         // SHARP PDA Browser (SHARP Zaurus)
460         // Sample: "sharp pda browser/6.1[ja](MI-E1/1.0) "
461         array('pattern'=>'#^(sharp [a-z]+ browser)/([0-9\.]+)#',        'profile'=>'keitai'),
462
463         // WebTV
464         array('pattern'=>'#^(WebTV)/([0-9\.]+)#',       'profile'=>'keitai'),
465
466     // Desktop-PC browsers
467
468         // Opera (for desktop PC, not embedded) -- See BugTrack/743 for detail
469         // NOTE: Keep this pattern above MSIE and Mozilla
470         // Sample: "Opera/7.0 (OS; U)" (not disguise)
471         // Sample: "Mozilla/4.0 (compatible; MSIE 5.0; OS) Opera 6.0" (disguise)
472         array('pattern'=>'#\b(Opera)[/ ]([0-9\.]+)\b#', 'profile'=>'default'),
473
474         // MSIE: Microsoft Internet Explorer (or something disguised as MSIE)
475         // Sample: "Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.0)"
476         array('pattern'=>'#\b(MSIE) ([0-9\.]+)\b#',     'profile'=>'default'),
477
478         // Mozilla Firefox
479         // NOTE: Keep this pattern above Mozilla
480         // Sample: "Mozilla/5.0 (Windows; U; Windows NT 5.0; ja-JP; rv:1.7) Gecko/20040803 Firefox/0.9.3"
481         array('pattern'=>'#\b(Firefox)/([0-9\.]+)\b#',  'profile'=>'default'),
482
483         // Loose default: Including something Mozilla
484         array('pattern'=>'#^([a-zA-z0-9 ]+)/([0-9\.]+)\b#',     'profile'=>'default'),
485
486         array('pattern'=>'#^#', 'profile'=>'default'),  // Sentinel
487 );
488 ?>