From a42742f869d2923c514de03110776e6d894659b5 Mon Sep 17 00:00:00 2001 From: Antoine Musso Date: Fri, 28 Jan 2005 00:01:44 +0000 Subject: [PATCH] Some clean up. Use phpdoc comments almost everywhere. Some extensions should really be moved as extensions :o) --- includes/DefaultSettings.php | 434 +++++++++++++++++++++-------------- 1 file changed, 264 insertions(+), 170 deletions(-) diff --git a/includes/DefaultSettings.php b/includes/DefaultSettings.php index 07ef7f39a6..56652ef6b4 100644 --- a/includes/DefaultSettings.php +++ b/includes/DefaultSettings.php @@ -24,7 +24,7 @@ $wgSitename = 'MediaWiki'; /** Will be same as you set @see $wgSitename */ $wgMetaNamespace = FALSE; -/** URL of the serve. It will be automaticly build including https mode */ +/** URL of the server. It will be automaticly build including https mode */ $wgServer = ''; if( isset( $_SERVER['SERVER_NAME'] ) ) { @@ -263,27 +263,37 @@ $wgMasterWaitTimeout = 10; # The sql user shouldn't have too many rights other the database, restrict # it to SELECT only on 'cur' table for example # -$wgAllowSysopQueries = false; # Dangerous if not configured properly. -$wgDBsqluser = 'sqluser'; -$wgDBsqlpassword = 'sqlpass'; -$wgDBpassword = 'userpass'; -$wgSqlLogFile = "{$wgUploadDirectory}/sqllog_mFhyRe6"; -$wgDBerrorLog = false; # File to log MySQL errors to - -# wgDBminWordLen : -# MySQL 3.x : used to discard words that MySQL will not return any results for -# shorter values configure mysql directly -# MySQL 4.x : ignore it and configure mySQL -# See: http://dev.mysql.com/doc/mysql/en/Fulltext_Fine-tuning.html +/** Dangerous if not configured properly. */ +$wgAllowSysopQueries = false; +$wgDBsqluser = 'sqluser'; +$wgDBsqlpassword = 'sqlpass'; +$wgDBpassword = 'userpass'; +$wgSqlLogFile = "{$wgUploadDirectory}/sqllog_mFhyRe6"; +/** File to log MySQL errors to */ +$wgDBerrorLog = false; + +/** + * wgDBminWordLen : + * MySQL 3.x : used to discard words that MySQL will not return any results for + * shorter values configure mysql directly. + * MySQL 4.x : ignore it and configure mySQL + * See: http://dev.mysql.com/doc/mysql/en/Fulltext_Fine-tuning.html + */ $wgDBminWordLen = 4; -$wgDBtransactions = false; # Set to true if using InnoDB tables -$wgDBmysql4 = false; # Set to true to use enhanced fulltext search +/** Set to true if using InnoDB tables */ +$wgDBtransactions = false; +/** Set to true to use enhanced fulltext search */ +$wgDBmysql4 = false; $wgSqlTimeout = 30; -$wgBufferSQLResults = true; # use buffered queries by default +/** use buffered queries by default */ +$wgBufferSQLResults = true; -# Other wikis on this site, can be administered from a single developer account -# Array, interwiki prefix => database name +/** + * Other wikis on this site, can be administered from a single developer + * account. + * Array, interwiki prefix => database name + */ $wgLocalDatabases = array(); @@ -310,26 +320,21 @@ $wgUseTurckShm = false; # Language settings # -/** - * Site language code - * Default to 'en'. Should be one of ./language/Language(.*).php - * @global string $wgLanguageCode - */ +/** Site language code, should be one of ./language/Language(.*).php */ $wgLanguageCode = 'en'; -/** - * Filename of a language file generated by dumpMessages.php - * @global string|false $wgLanguageFile (default:false) - */ +/** Filename of a language file generated by dumpMessages.php */ $wgLanguageFile = false; -/** - * Treat language links as magic connectors, not inline links - * @global bool $wgInterwikiMagic (default:true) - */ + +/** Treat language links as magic connectors, not inline links */ $wgInterwikiMagic = true; -$wgInputEncoding = 'ISO-8859-1'; # LanguageUtf8.php normally overrides this -$wgOutputEncoding = 'ISO-8859-1'; # unless you set the next option to true: -$wgUseLatin1 = false; # Enable ISO-8859-1 compatibility mode + +/** LanguageUtf8.php normally overrides this */ +$wgInputEncoding = 'ISO-8859-1'; +/** unless you set the next option to true: */ +$wgOutputEncoding = 'ISO-8859-1'; +/** Enable ISO-8859-1 compatibility mode */ +$wgUseLatin1 = false; $wgEditEncoding = ''; # Set this to eg 'ISO-8859-1' to perform character set @@ -345,12 +350,17 @@ $wgLegacyEncoding = false; $wgMimeType = 'text/html'; $wgDocType = '-//W3C//DTD XHTML 1.0 Transitional//EN'; $wgDTD = 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd'; -$wgUseDynamicDates = false; # Enable to allow rewriting dates in page text - # DOES NOT FORMAT CORRECTLY FOR MOST LANGUAGES -$wgAmericanDates = false; # Enable for English module to print dates - # as eg 'May 12' instead of '12 May' -$wgTranslateNumerals = true; # For Hindi and Arabic use local numerals instead - # of Western style (0-9) numerals in interface. + +/** Enable to allow rewriting dates in page text. + * DOES NOT FORMAT CORRECTLY FOR MOST LANGUAGES */ +$wgUseDynamicDates = false; +/** Enable for English module to print dates as eg 'May 12' instead of '12 May' */ +$wgAmericanDates = false; +/** + * For Hindi and Arabic use local numerals instead of Western style (0-9) + * numerals in interface. + */ +$wgTranslateNumerals = true; # Translation using MediaWiki: namespace @@ -464,69 +474,84 @@ $wgAutoblockExpiry = 86400; # Number of seconds before autoblock entries expire # Proxy scanner settings # -# -# If you enable this, every editor's IP address will be scanned for open -# HTTP proxies. -# -# Don't enable this. Many sysops will report "hostile TCP port scans" to -# your ISP and ask for your server to be shut down. -# -# You have been warned. -# -$wgBlockOpenProxies = false; # Automatic open proxy test on edit + +/** + * If you enable this, every editor's IP address will be scanned for open HTTP + * proxies. + * + * Don't enable this. Many sysops will report "hostile TCP port scans" to your + * ISP and ask for your server to be shut down. + * + * You have been warned. + */ +$wgBlockOpenProxies = false; +/** Port we want to scan for a proxy */ $wgProxyPorts = array( 80, 81, 1080, 3128, 6588, 8000, 8080, 8888, 65506 ); +/** Script used to scan */ $wgProxyScriptPath = "$IP/proxy_check.php"; +/** */ $wgProxyMemcExpiry = 86400; +/** */ $wgProxyKey = 'W1svekXc5u6lZllTZOwnzEk1nbs'; -$wgProxyList = array(); # big list of banned IP addresses, in the keys not the values +/** big list of banned IP addresses, in the keys not the values */ +$wgProxyList = array(); -# Number of accounts each IP address may create, 0 to disable. -# Requires memcached +/** Number of accounts each IP address may create, 0 to disable. + * Requires memcached */ $wgAccountCreationThrottle = 0; - # Client-side caching: -$wgCachePages = true; # Allow client-side caching of pages -# Set this to current time to invalidate all prior cached pages. -# Affects both client- and server-side caching. +/** Allow client-side caching of pages */ +$wgCachePages = true; + +/** + * Set this to current time to invalidate all prior cached pages. Affects both + * client- and server-side caching. + */ $wgCacheEpoch = '20030516000000'; # Server-side caching: -# This will cache static pages for non-logged-in users -# to reduce database traffic on public sites. -# Must set $wgShowIPinHeader = false + +/** + * This will cache static pages for non-logged-in users to reduce + * database traffic on public sites. + * Must set $wgShowIPinHeader = false + */ $wgUseFileCache = false; +/** Directory where the cached page will be saved */ $wgFileCacheDirectory = "{$wgUploadDirectory}/cache"; -# When using the file cache, we can store the cached HTML gzipped to save disk -# space. Pages will then also be served compressed to clients that support it. -# THIS IS NOT COMPATIBLE with ob_gzhandler which is now enabled if supported in -# the default LocalSettings.php! If you enable this, remove that setting first. -# -# Requires zlib support enabled in PHP. +/** + * When using the file cache, we can store the cached HTML gzipped to save disk + * space. Pages will then also be served compressed to clients that support it. + * THIS IS NOT COMPATIBLE with ob_gzhandler which is now enabled if supported in + * the default LocalSettings.php! If you enable this, remove that setting first. + * + * Requires zlib support enabled in PHP. + */ $wgUseGzip = false; - # Email notification settings # -# Program to run when the email is actually sent out. You might want to make -# your server beep for example with: -# -# $wgEmailNotificationSystembeep = '/usr/bin/beep -f 4000 -l 20 &'; -# -# Usermailer.php will make a system() call with exactly that string as parameter +/** + * Program to run when the email is actually sent out. You might want to make + * your server beep for example. Usermailer.php will make a system() call with + * exactly that string as parameter. + */ +# $wgEmailNotificationSystembeep = '/usr/bin/beep -f 4000 -l 20 &'; $wgEmailNotificationSystembeep = ''; -# For email notification on page changes +/** For email notification on page changes */ $wgPasswordSender = $wgEmergencyContact; # true: from PageEditor if s/he opted-in # false: Enotif mails appear to come from $wgEmergencyContact $wgEmailNotificationMailsSentFromPageEditor = false; +// TODO move UPO to preferences probably ? # If set to true, users get a corresponding option in their preferences and can choose to enable or disable at their discretion # If set to false, the corresponding input form on the user preference page is suppressed # It call this to be a "user-preferences-option (UPO)" @@ -538,12 +563,13 @@ $wgEmailNotificationForMinorEdits = true; # UPO; false: "minor edits" on pages # # Attention: _every_ change on a user_talk page trigger a notification mail (if the user is not yet notified) - -# Show watching users in recent changes, watchlist and page history views +/** Show watching users in recent changes, watchlist and page history views */ $wgRCShowWatchingUsers = false; # UPO -# Show watching users in Page views +/** Show watching users in Page views */ $wgPageShowWatchingUsers = false; -# Show "Updated (since my last visit)" marker in RC view, watchlist and history view for watched pages with new changes +/** + * Show "Updated (since my last visit)" marker in RC view, watchlist and history + * view for watched pages with new changes */ $wgShowUpdatedMarker = true; # UPO $wgCookieExpiration = 2592000; @@ -551,87 +577,129 @@ $wgCookieExpiration = 2592000; # Squid-related settings # -# Enable/disable Squid - $wgUseSquid = false; +/** Enable/disable Squid */ +$wgUseSquid = false; -# If you run Squid3 with ESI support, enable this (default:false): - $wgUseESI = false; +/** If you run Squid3 with ESI support, enable this (default:false): */ +$wgUseESI = false; -# Internal server name as known to Squid, if different +/** Internal server name as known to Squid, if different */ # $wgInternalServer = 'http://yourinternal.tld:8000'; - $wgInternalServer = $wgServer; +$wgInternalServer = $wgServer; -# Cache timeout for the squid, will be sent as s-maxage (without ESI) or -# Surrogate-Control (with ESI). Without ESI, you should strip out s-maxage in the Squid config. -# 18000 seconds = 5 hours, more cache hits with 2678400 = 31 days - $wgSquidMaxage = 18000; +/** + * Cache timeout for the squid, will be sent as s-maxage (without ESI) or + * Surrogate-Control (with ESI). Without ESI, you should strip out s-maxage in + * the Squid config. 18000 seconds = 5 hours, more cache hits with 2678400 = 31 + * days + */ +$wgSquidMaxage = 18000; -# A list of proxy servers (ips if possible) to purge on changes -# don't specify ports here (80 is default) +/** + * A list of proxy servers (ips if possible) to purge on changes don't specify + * ports here (80 is default) + */ # $wgSquidServers = array('127.0.0.1'); $wgSquidServersNoPurge = array(); -# Maximum number of titles to purge in any one client operation +/** Maximum number of titles to purge in any one client operation */ $wgMaxSquidPurgeTitles = 400; # Cookie settings: -# Set to set an explicit domain on the login cookies -# eg, "justthis.domain.org" or ".any.subdomain.net" +# +/** + * Set to set an explicit domain on the login cookies eg, "justthis.domain. org" + * or ".any.subdomain.net" + */ $wgCookieDomain = ''; $wgCookiePath = '/'; $wgDisableCookieCheck = false; -# Whether to allow inline image pointing to other websites +/** Whether to allow inline image pointing to other websites */ $wgAllowExternalImages = true; -$wgMiserMode = false; # Disable database-intensive features -$wgDisableQueryPages = false; # Disable all query pages if miser mode is on, not just some -$wgUseWatchlistCache = false; # Generate a watchlist once every hour or so -$wgWLCacheTimeout = 3600; # The hour or so mentioned above +/** Disable database-intensive features */ +$wgMiserMode = false; +/** Disable all query pages if miser mode is on, not just some */ +$wgDisableQueryPages = false; +/** Generate a watchlist once every hour or so */ +$wgUseWatchlistCache = false; +/** The hour or so mentioned above */ +$wgWLCacheTimeout = 3600; -# To use inline TeX, you need to compile 'texvc' (in the 'math' subdirectory -# of the MediaWiki package and have latex, dvips, gs (ghostscript), and -# convert (ImageMagick) installed and available in the PATH. -# Please see math/README for more information. +/** + * To use inline TeX, you need to compile 'texvc' (in the 'math' subdirectory of + * the MediaWiki package and have latex, dvips, gs (ghostscript), andconvert + * (ImageMagick) installed and available in the PATH. + * Please see math/README for more information. + */ $wgUseTeX = false; -$wgTexvc = './math/texvc'; # Location of the texvc binary +/** Location of the texvc binary */ +$wgTexvc = './math/texvc'; +# # Profiling / debugging -$wgProfiling = false; # Enable for more detailed by-function times in debug log -$wgProfileLimit = 0.0; # Only record profiling info for pages that took longer than this -$wgProfileOnly = false; # Don't put non-profiling info into log file -$wgProfileToDatabase = false; # Log sums from profiling into "profiling" table in db. -$wgProfileSampleRate = 1; # Only profile every n requests when profiling is turned on -$wgProfileCallTree = false; # If true, print a raw call tree instead of per-function report +# -$wgDebugProfiling = false; # Detects non-matching wfProfileIn/wfProfileOut calls -$wgDebugFunctionEntry = 0; # Output debug message on every wfProfileIn/wfProfileOut -$wgDebugSquid = false; # Lots of debugging output from SquidUpdate.php +/** Enable for more detailed by-function times in debug log */ +$wgProfiling = false; +/** Only record profiling info for pages that took longer than this */ +$wgProfileLimit = 0.0; +/** Don't put non-profiling info into log file */ +$wgProfileOnly = false; +/** Log sums from profiling into "profiling" table in db. */ +$wgProfileToDatabase = false; +/** Only profile every n requests when profiling is turned on */ +$wgProfileSampleRate = 1; +/** If true, print a raw call tree instead of per-function report */ +$wgProfileCallTree = false; + +/** Detects non-matching wfProfileIn/wfProfileOut calls */ +$wgDebugProfiling = false; +/** Output debug message on every wfProfileIn/wfProfileOut */ +$wgDebugFunctionEntry = 0; +/** Lots of debugging output from SquidUpdate.php */ +$wgDebugSquid = false; $wgDisableCounters = false; $wgDisableTextSearch = false; -$wgDisableSearchUpdate = false; # If you've disabled search semi-permanently, this also disables updates to the table. If you ever re-enable, be sure to rebuild the search table. -$wgDisableUploads = true; # Uploads have to be specially set up to be secure -$wgRemoteUploads = false; # Set to true to enable the upload _link_ while local uploads are disabled. Assumes that the special page link will be bounced to another server where uploads do work. +/** + * If you've disabled search semi-permanently, this also disables updates to the + * table. If you ever re-enable, be sure to rebuild the search table. + */ +$wgDisableSearchUpdate = false; +/** Uploads have to be specially set up to be secure */ +$wgDisableUploads = true; +/** + * Set to true to enable the upload _link_ while local uploads are disabled. + * Assumes that the special page link will be bounced to another server where + * uploads do work. + */ +$wgRemoteUploads = false; $wgDisableAnonTalk = false; -# Path to the GNU diff3 utility. If the file doesn't exist, -# edit conflicts will fall back to the old behaviour (no merging). +/** + * Path to the GNU diff3 utility. If the file doesn't exist, edit conflicts will + * fall back to the old behaviour (no merging). + */ $wgDiff3 = '/usr/bin/diff3'; - -# We can also compress text in the old revisions table. If this is set on, -# old revisions will be compressed on page save if zlib support is available. -# Any compressed revisions will be decompressed on load regardless of this -# setting *but will not be readable at all* if zlib support is not available. +/** + * We can also compress text in the old revisions table. If this is set on, old + * revisions will be compressed on page save if zlib support is available. Any + * compressed revisions will be decompressed on load regardless of this setting + * *but will not be readable at all* if zlib support is not available. + */ $wgCompressRevisions = false; -# This is the list of preferred extensions for uploading files. Uploading -# files with extensions not in this list will trigger a warning. +/** + * This is the list of preferred extensions for uploading files. Uploading files + * with extensions not in this list will trigger a warning. + */ $wgFileExtensions = array( 'png', 'gif', 'jpg', 'jpeg', 'ogg' ); -# Files with these extensions will never be allowed as uploads. +/** Files with these extensions will never be allowed as uploads. */ $wgFileBlacklist = array( # HTML may contain cookie-stealing JavaScript and web bugs 'html', 'htm', @@ -642,44 +710,50 @@ $wgFileBlacklist = array( # May contain harmful executables for Windows victims 'exe', 'scr', 'dll', 'msi', 'vbs', 'bat', 'com', 'pif', 'cmd', 'vxd', 'cpl' ); -# This is a flag to determine whether or not to check file extensions on -# upload. +/** This is a flag to determine whether or not to check file extensions on upload. */ $wgCheckFileExtensions = true; -# If this is turned off, users may override the warning for files not -# covered by $wgFileExtensions. +/** + * If this is turned off, users may override the warning for files not covered + * by $wgFileExtensions. + */ $wgStrictFileExtensions = true; -# Warn if uploaded files are larger than this +/** Warn if uploaded files are larger than this */ $wgUploadSizeWarning = 150000; -$wgPasswordSalt = true; # For compatibility with old installations set to false +/** For compatibility with old installations set to false */ +$wgPasswordSalt = true; -# Which namespaces should support subpages? -# See Language.php for a list of namespaces. -# +/** Which namespaces should support subpages? + * See Language.php for a list of namespaces. + */ $wgNamespacesWithSubpages = array( -1 => 0, 0 => 0, 1 => 1, 2 => 1, 3 => 1, 4 => 0, 5 => 1, 6 => 0, 7 => 1, 8 => 0, 9 => 1, 10 => 0, 11 => 1); $wgNamespacesToBeSearchedDefault = array( -1 => 0, 0 => 1, 1 => 0, 2 => 0, 3 => 0, 4 => 0, 5 => 0, 6 => 0, 7 => 0, 8 => 0, 9 => 1, 10 => 0, 11 => 1 ); -# If set, a bold ugly notice will show up at the top of every page. -$wgSiteNotice = ""; +/** If set, a bold ugly notice will show up at the top of every page. */ +$wgSiteNotice = ''; -## Set $wgUseImageResize to true if you want to enable dynamic -## server side image resizing ("Thumbnails") -# -$wgUseImageResize = false; -## Resizing can be done using PHP's internal image libraries -## or using ImageMagick. The later supports more file formats -## than PHP, which only supports PNG, GIF, JPG, XBM and WBMP. -## -## Set $wgUseImageMagick to true to use Image Magick instead -## of the builtin functions # +# Images settings +# + +/** dynamic server side image resizing ("Thumbnails") */ +$wgUseImageResize = false; + +/** + * Resizing can be done using PHP's internal image libraries or using + * ImageMagick. The later supports more file formats than PHP, which only + * supports PNG, GIF, JPG, XBM and WBMP. + * + * Use Image Magick instead of PHP builtin functions. + */ $wgUseImageMagick = false; +/** The convert command shipped with ImageMagick */ $wgImageMagickConvertCommand = '/usr/bin/convert'; # Scalable Vector Graphics (SVG) may be uploaded as images. @@ -693,22 +767,38 @@ $wgSVGConverters = array( 'inkscape' => '$path/inkscape -z -w $width -f $input -e $output', 'batik' => 'java -Djava.awt.headless=true -jar $path/batik-rasterizer.jar -w $width -d $output $input', ); -$wgSVGConverter = 'ImageMagick'; # Pick one of the above -$wgSVGConverterPath = ''; # If not in the executable PATH, specify +/** Pick one of the above */ +$wgSVGConverter = 'ImageMagick'; +/** If not in the executable PATH, specify */ +$wgSVGConverterPath = ''; +/** @todo FIXME what does it do here ?? [ashar] */ if( !isset( $wgCommandLineMode ) ) { $wgCommandLineMode = false; } + +# +# Recent changes settings +# + /** Show seconds in Recent Changes */ $wgRCSeconds = false; /** Log IP addresses in the recentchanges table */ $wgPutIPinRC = false; -# Recentchanges items are periodically purged; -# entries older than this many seconds will go. -$wgRCMaxAge = 7 * 24 * 3600; # our one week cutoff +/** + * Recentchanges items are periodically purged; entries older than this many + * seconds will go. + * For one week : 7 * 24 * 3600 + */ +$wgRCMaxAge = 7 * 24 * 3600; + + +# +# Copyright and credits settings +# /** RDF metadata toggles */ $wgEnableDublinCoreRdf = false; @@ -732,6 +822,20 @@ $wgUseCopyrightUpload = false; * information values are not empty. */ $wgCheckCopyrightUpload = true; +/** + * Set this to the number of authors that you want to be credited below an + * article text. Set it to zero to hide the attribution block, and a negative + * number (like -1) to show all authors. Note that this will# require 2-3 extra + * database hits, which can have a not insignificant impact on performance for + * large wikis. + */ +$wgMaxCredits = 0; + +/** If there are more than $wgMaxCredits authors, show $wgMaxCredits of them. + * Otherwise, link to a separate credits page. */ +$wgShowCreditsIfMax = true; + + /** * Set this to false to avoid forcing the first letter of links to capitals. @@ -748,18 +852,7 @@ $wgCapitalLinks = true; */ $wgImportSources = array(); -/** - * Set this to the number of authors that you want to be credited below an - * article text. Set it to zero to hide the attribution block, and a negative - * number (like -1) to show all authors. Note that this will# require 2-3 extra - * database hits, which can have a not insignificant impact on performance for - * large wikis. - */ -$wgMaxCredits = 0; -/** If there are more than $wgMaxCredits authors, show $wgMaxCredits of them. - * Otherwise, link to a separate credits page. */ -$wgShowCreditsIfMax = true; /** Text matching this regular expression will be recognised as spam * See http://en.wikipedia.org/wiki/Regular_expression */ @@ -799,13 +892,14 @@ $wgTidyOpts = ''; /** See list of skins and their symbolic names in languagel/Language.php */ $wgDefaultSkin = 'monobook'; -# Settings added to this array will override the language globals for -# the user preferences used by anonymous visitors and newly created -# accounts. (See names and sample values in languages/Language.php) -# -# For instance, to disable section editing links: -# $wgDefaultUserOptions['editsection'] = 0; -# +/** + * Settings added to this array will override the language globals for the user + * preferences used by anonymous visitors and newly created accounts. (See names + * and sample values in languages/Language.php) + * For instance, to disable section editing links: + * $wgDefaultUserOptions ['editsection'] = 0; + * + */ $wgDefaultUserOptions = array(); /** Whether or not to allow and use real name fields. Defaults to true. */ @@ -1032,4 +1126,4 @@ $wgNoFollowLinks = true; } else { die(); } -?> +?> \ No newline at end of file -- 2.20.1