GNUsocial/gnu-social
4
0
Fork 1
Code Issues Releases Wiki Activity

[DEFAULTS] Remove deprecated defaults and convert them to snake_case

Browse Source
This commit is contained in:
Hugo Sales 2020-05-16 20:42:31 +00:00 committed by Hugo Sales
parent 6cc19b83df
commit 4deb446f39
Signed by: someonewithpc
GPG Key ID: 7D0C7EAFC9D835A0
3 changed files with 169 additions and 235 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
bin/configure vendored
View File

@ -23,8 +23,8 @@ printf "Admin nickname: " && read -r admin_nick
printf "Admin password: " && read -r admin_password
while :; do
printf "Site profile (public|private|community|singleuser): " && read -r profile
[ $(echo "${profile}" | grep -E 'public|private|community|singleuser') ] && break
printf "Site profile (public|private|community|single_user): " && read -r profile
[ $(echo "${profile}" | grep -E 'public|private|community|single_user') ] && break
done
mkdir -p ./docker/db

346
src/Core/DefaultSettings.php
View File

@ -40,88 +40,55 @@ abstract class DefaultSettings
{
self::$defaults =
['site' =>
['name' => $_ENV['SOCIAL_SITENAME'],
'theme' => 'neo-gnu',
'logo' => null,
'ssllogo' => null,
'fancy' => true,
'locale_path' => INSTALLDIR . '/translations',
'language' => 'en',
'langdetect' => true,
'languages' => I18n::get_all_languages(),
'email' => $_ENV['SERVER_ADMIN'] ?? $_ENV['SOCIAL_ADMIN_EMAIL'] ?? null,
'recovery_hide_address_known' => true, // Whether to not say that we found the email in the database, when asking for recovery
'broughtby' => null,
'timezone' => 'UTC',
'broughtbyurl' => null,
'closed' => false,
'inviteonly' => true,
'private' => false,
'ssl' => 'never',
'sslproxy' => false, // set to true to force GNU social to think it is HTTPS (i.e. using reverse proxy to enable it)
'sslserver' => null,
'dupelimit' => 60, // default for same person saying the same thing
'textlimit' => 1000, // in chars; 0 == no limit
'indent' => true,
'use_x_sendfile' => false,
'notice' => null, // site wide notice text
'build' => 1, // build number, for code-dependent cache
['name' => $_ENV['SOCIAL_SITENAME'],
'notice' => null, // site wide notice text
'theme' => 'neo-gnu',
'logo' => null,
'fancy' => true,
'locale_path' => INSTALLDIR . '/translations',
'language' => 'en',
'langdetect' => true,
'languages' => I18n::get_all_languages(),
'email' => $_ENV['SERVER_ADMIN'] ?? $_ENV['SOCIAL_ADMIN_EMAIL'] ?? null,
'recovery_disclose' => false, // Whether to not say that we found the email in the database, when asking for recovery
'timezone' => 'UTC',
'brought_by' => null,
'brought_by_url' => null,
'closed' => false,
'invite_only' => true,
'private' => false,
'ssl' => 'always',
'ssl_proxy' => false, // set to true to force GNU social to think it is HTTPS (i.e. using reverse proxy to enable it)
'ssl_proxy_server' => null,
'duplicate_time_limit' => 60, // default for same person saying the same thing
'text_limit' => 1000, // in chars; 0 == no limit
'use_x_sendfile' => false,
'description_limit' => null
],
'security' => ['hash_algos' => ['sha1', 'sha256', 'sha512']], // set to null for anything that hash_hmac() can handle (and is in hash_algos())
'db' =>
['database' => null, // must be set
'schema_location' => INSTALLDIR . '/classes',
'class_location' => INSTALLDIR . '/classes',
'require_prefix' => 'classes/',
'class_prefix' => '',
'mirror' => null,
'utf8' => true,
'db_driver' => 'DB', // XXX: JanRain libs only work with DB
'disable_null_strings' => true, // 'NULL' can be harmful
'quote_identifiers' => true,
'type' => 'mysql',
'schemacheck' => 'runtime', // 'runtime' or 'script'
'annotate_queries' => false, // true to add caller comments to queries, eg /* POST Notice::saveNew */
'log_queries' => false, // true to log all DB queries
'log_slow_queries' => 0, // if set, log queries taking over N seconds
'mysql_foreign_keys' => false, ], // if set, enables experimental foreign key support on MySQL
'db' => ['mirror' => null], // TODO implement
'fix' =>
['fancyurls' => true, // makes sure aliases in WebFinger etc. are not f'd by index.php/ URLs
'legacy_http' => false, // set this to true if you have upgraded your site from http=>https
],
'log' => [
'debugtrace' => false, // index.php handleError function, whether to include exception backtrace in log
],
'syslog' =>
['appname' => 'statusnet', // for syslog
'priority' => 'debug', // XXX: currently ignored
'facility' => LOG_USER,
],
'queue' =>
['enabled' => true,
'daemon' => false, // Use queuedaemon. Default to false
'threads' => null, // an empty value here uses processor count to determine
'subsystem' => 'db', // default to database, or 'stomp'
'subsystem' => false, // default to database, or 'stomp'
'basename' => '/gnusocial/queue/',
'control_channel' => '/topic/gnusocial/control', // broadcasts to all queue daemons
'monitor' => null, // URL to monitor ping endpoint (work in progress)
'softlimit' => '90%', // total size or % of memory_limit at which to restart queue threads gracefully
'spawndelay' => 1, // Wait at least N seconds between (re)spawns of child processes to avoid slamming the queue server with subscription startup
'debug_memory' => false, // true to spit memory usage to log
'stomp_server' => null,
'queue_basename' => '/queue/statusnet/',
'control_channel' => '/topic/statusnet/control', // broadcasts to all queue daemons
'stomp_username' => null,
'stomp_password' => null,
'stomp_persistent' => true, // keep items across queue server restart, if persistence is enabled
'stomp_transactions' => true, // use STOMP transactions to aid in detecting failures (supported by ActiveMQ, but not by all)
'stomp_acks' => true, // send acknowledgements after successful processing (supported by ActiveMQ, but not by all)
'stomp_manual_failover' => true, // if multiple servers are listed, treat them as separate (enqueue on one randomly, listen on all)
'monitor' => null, // URL to monitor ping endpoint (work in progress)
'softlimit' => '90%', // total size or % of memory_limit at which to restart queue threads gracefully
'spawndelay' => 1, // Wait at least N seconds between (re)spawns of child processes to avoid slamming the queue server with subscription startup
'debug_memory' => false, // true to spit memory usage to log
'breakout' => [], // List queue specifiers to break out when using Stomp queue.
// Default will share all queues for all sites within each group.
// Specify as <group>/<queue> or <group>/<queue>/<site>,
// using nickname identifier as site.
//
// 'main/distrib' separate "distrib" queue covering all sites
// 'xmpp/xmppout/mysite' separate "xmppout" queue covering just 'mysite'
'max_retries' => 10, // drop messages after N failed attempts to process (Stomp)
'dead_letter_dir' => false, // set to directory to save dropped messages into (Stomp)
],
@ -130,7 +97,7 @@ abstract class DefaultSettings
'owner' => null, // can be name of content owner e.g. for enterprise
'url' => 'https://creativecommons.org/licenses/by/3.0/',
'title' => 'Creative Commons Attribution 3.0',
// 'image' => $_path . '/theme/licenses/cc_by_3.0_80x15.png',
'image' => '/theme/licenses/cc_by_3.0_80x15.png',
],
'mail' =>
['backend' => 'mail',
@ -142,54 +109,38 @@ abstract class DefaultSettings
'featured' => [],
],
'profile' =>
['banned' => [],
'biolimit' => null,
'changenick' => false,
'allowprivate' => false, // whether to allow setting stream to private ("only followers can read")
'backup' => false, // can cause DoS, so should be done via CLI
'restore' => false,
'delete' => false,
'move' => true,
['banned' => [],
'bio_text_limit' => null,
'allow_change_nick' => false,
'allow_private_stream' => false, // whether to allow setting stream to private ("only followers can read")
'backup' => false, // can cause DoS, so should be done via CLI
'restore' => false,
'delete' => false,
'move' => false,
],
'image' => ['jpegquality' => 85],
'avatar' =>
['server' => null,
'dir' => INSTALLDIR . '/file/avatar/',
// 'url_base' => $_path . '/avatar/',
'ssl' => null,
'maxsize' => 300,
['server' => null,
'dir' => INSTALLDIR . '/file/avatar/',
'url_base' => '/avatar/',
'ssl' => null,
'max_px_size' => 300,
],
'foaf' => ['mbox_sha1sum' => false],
'public' =>
['localonly' => false,
'blacklist' => [],
'autosource' => [],
],
'theme' =>
['server' => null,
'dir' => null,
'path' => null,
'ssl' => null,
],
'usertheme' =>
['linkcolor' => 'black',
'backgroundcolor' => 'black',
['local_only' => false,
'blacklist' => [],
'exclude_sources' => [],
],
'theme_upload' => ['enabled' => extension_loaded('zip')],
'javascript' =>
['server' => null,
'path' => null,
'url_base' => null,
'ssl' => null,
'bustframes' => true,
],
'local' => // To override path/server for themes in 'local' dir (not currently applied to local plugins)
['server' => null,
'dir' => null,
'path' => null,
'ssl' => null,
],
'throttle' =>
['enabled' => false, // whether to throttle edits; false by default
['enabled' => true, // whether to throttle posting dents
'count' => 20, // number of allowed messages in timespan
'timespan' => 600, // timespan for throttling
],
@ -207,27 +158,15 @@ abstract class DefaultSettings
'user' => false,
'group' => false,
],
'emailpost' => ['enabled' => false],
'sms' => ['enabled' => false],
'twitterimport' => ['enabled' => false],
'integration' =>
['source' => 'StatusNet', // source attribute for Twitter
'taguri' => null, // base for tag URIs
],
'twitter' =>
['signin' => true,
'consumer_key' => null,
'consumer_secret' => null,
],
'cache' => ['base' => null],
'email_post' => ['enabled' => false],
'sms' => ['enabled' => false],
'ping' =>
['notify' => [],
'timeout' => 2,
],
'inboxes' => ['enabled' => true], // ignored after 0.9.x
'newuser' =>
['default' => null,
'welcome' => null,
'new_users' =>
['default_subscriptions' => null,
'welcome_user' => null,
],
'linkify' => // "bare" below means "without schema", like domain.com vs. https://domain.com
['bare_domains' => false, // convert domain.com to <a href="http://domain.com/" ...>domain.com</a> ?
@ -235,12 +174,10 @@ abstract class DefaultSettings
'bare_ipv6' => false, // convert IPv6 addresses to hyperlinks?
],
'attachments' =>
['server' => null,
'dir' => INSTALLDIR . '/file/',
// 'path' => $_path . '/file/',
'sslserver' => null,
'sslpath' => null,
'ssl' => null,
['server' => null,
'dir' => INSTALLDIR . '/file/',
'url_base' => '/file/',
'ssl' => null,
'supported' =>
['application/vnd.oasis.opendocument.chart' => 'odc',
'application/vnd.oasis.opendocument.formula' => 'odf',
@ -264,8 +201,8 @@ abstract class DefaultSettings
image_type_to_mime_type(IMAGETYPE_PNG) => image_type_to_extension(IMAGETYPE_PNG),
image_type_to_mime_type(IMAGETYPE_JPEG) => image_type_to_extension(IMAGETYPE_JPEG),
image_type_to_mime_type(IMAGETYPE_GIF) => image_type_to_extension(IMAGETYPE_GIF),
'image/svg+xml' => 'svg', // No built-in constant
image_type_to_mime_type(IMAGETYPE_ICO) => image_type_to_extension(IMAGETYPE_ICO),
'image/svg+xml' => 'svg', // No built-in constant
'audio/ogg' => 'ogg',
'audio/mpeg' => 'mpg',
'audio/x-speex' => 'spx',
@ -277,126 +214,72 @@ abstract class DefaultSettings
'video/quicktime' => 'mov',
'video/webm' => 'webm',
],
// 'file_quota' => common_get_preferred_php_upload_limit(),
'user_quota' => 50000000,
'monthly_quota' => 15000000,
'file_quota' => Common::get_preferred_php_upload_limit(),
'user_quota' => Common::size_str_to_int('200M'),
'monthly_quota' => Common::size_str_to_int('20M'),
'uploads' => true,
'show_html' => false, // show (filtered) text/html attachments (and oEmbed HTML etc.). Doesn't affect AJAX calls.
'show_html' => true, // show (filtered) text/html attachments (and oEmbed HTML etc.). Doesn't affect AJAX calls.
'show_thumbs' => true, // show thumbnails in notice lists for uploaded images, and photos and videos linked remotely that provide oEmbed info
'process_links' => true, // check linked resources for embeddable photos and videos; this will hit referenced external web sites when processing new messages.
'extblacklist' => [],
'memory_limit' => '1024M', // PHP's memory limit to use temporarily when handling images
'ext_blacklist' => [],
'memory_limit' => '1024M', // PHP memory limit to use temporarily when handling images
],
'thumbnail' =>
['dir' => null, // falls back to File::path('thumb') (equivalent to ['attachments']['dir'] . '/thumb/')
'path' => null, // falls back to generating a URL with File::url('thumb/$filename') (equivalent to ['attachments']['path'] . '/thumb/')
'server' => null, // Only used if ['thumbnail']['path'] is NOT empty, and then it falls back to ['site']['server'], schema is decided from GNUsocial::useHTTPS()
'crop' => false, // overridden to true if thumb height === null
'maxsize' => 1000, // thumbs with an edge larger than this will not be generated
'width' => 450,
'height' => 600,
'upscale' => false,
'animated' => false, // null="UseFileAsThumbnail", false="can use still frame". true requires ImageMagickPlugin
['dir' => INSTALLDIR . '/file/thumbnails/', // falls back to File::path('thumb') (equivalent to ['attachments']['dir'] . '/thumb/')
'url_base' => null, // falls back to generating a URL with File::url('thumb/$filename') (equivalent to ['attachments']['path'] . '/thumb/')
'server' => null, // Only used if ['thumbnail']['path'] is NOT empty, and then it falls back to ['site']['server'], schema is decided from GNUsocial::useHTTPS()
'crop' => false, // overridden to true if thumb height === null
'max_px_size' => 1000, // thumbs with an edge larger than this will not be generated
'width' => 450,
'height' => 600,
'upscale' => false,
'animated' => false, // null="UseFileAsThumbnail", false="can use still frame". true="allow animated"
],
'application' => ['desclimit' => null],
'group' =>
['maxaliases' => 3,
'desclimit' => null,
'addtag' => true,
'group' =>
['max_aliases' => 3,
'description_limit' => null,
'auto_add_tag' => true,
],
'peopletag' =>
['maxtags' => 100, // maximum number of tags a user can create.
'maxpeople' => 500, // maximum no. of people with the same tag by the same user
'allow_tagging' => ['all' => true], // equivalent to array('local' => true, 'remote' => true)
'desclimit' => null,
'people_tag' =>
['max_tags' => 100, // maximum number of tags a user can create.
'max_people' => 500, // maximum no. of people with the same tag by the same user
'allow_tagging' => ['all' => true], // equivalent to array('local' => true, 'remote' => true)
'description_limit' => null,
],
'search' => ['type' => 'like'],
'sessions' =>
['handle' => false, // whether to handle sessions ourselves
'debug' => false, // debugging output for sessions
'gc_limit' => 1000, // max sessions to expire at a time
],
'htmlfilter' => // remove tags from user/remotely generated HTML if they are === true
['img' => true,
'video' => true,
'audio' => true,
],
'htmlpurifier' => // configurable options for HTMLPurifier
['Cache.DefinitionImpl' => 'Serializer',
'Cache.SerializerPath' => implode(DIRECTORY_SEPARATOR, [sys_get_temp_dir(), 'gnusocial']),
'search' => ['type' => 'like'],
'html_filter' => // remove tags from user/remotely generated HTML if they are === true
['img' => true,
'video' => true,
'audio' => true,
'script' => true,
],
'notice' =>
['contentlimit' => null,
'allowprivate' => false, // whether to allow users to "check the padlock" to publish notices available for their subscribers.
'defaultscope' => null, // null means 1 if site/private, 0 otherwise
'hidespam' => true, // Whether to hide silenced users from timelines
['content_limit' => null,
'allow_private' => false, // whether to allow users to "check the padlock" to publish notices available for their subscribers.
'default_scope' => null, // null means 1 if site/private, 0 otherwise
'hide_spam' => true, // Whether to hide silenced users from timelines
],
'message' => ['contentlimit' => null],
'message' => ['content_limit' => null],
'location' =>
['share' => 'user', // whether to share location; 'always', 'user', 'never'
'sharedefault' => false, ],
'logincommand' => ['disabled' => true],
'plugins' =>
['core' =>
['Activity' => [],
'ActivityModeration' => [],
'ActivityVerb' => [],
'ActivityVerbPost' => [],
'AuthCrypt' => [],
'Favorite' => [],
'HTMLPurifierSchemes' => [],
'Share' => [],
'TheFreeNetwork' => [
'protocols' => ['ActivityPub' => 'Activitypub_profile', 'OStatus' => 'Ostatus_profile'],
],
],
'default' =>
['AccountManager' => [],
'AntiBrute' => [],
'Blacklist' => [],
'Bookmark' => [],
'ClientSideShorten' => [],
'Cronish' => [],
'DefaultLayout' => [],
'DirectionDetector' => [],
'DirectMessage' => [],
'Directory' => [],
'EmailAuthentication' => [],
'Embed' => [],
'Event' => [],
'LRDD' => [],
'Nodeinfo' => [],
'OpenID' => [],
'DBQueue' => [],
'OpportunisticQM' => [],
'RemoteFollow' => [],
'ActivityPub' => [], // The order is important here (IT HAS TO COME BEFORE OSTATUS)
'OStatus' => [],
'Poll' => [],
'SimpleCaptcha' => [],
'TagSub' => [],
'WebFinger' => [],
],
['share' => 'user', // whether to share location; 'always', 'user', 'never'
'share_default' => false, ],
'plugins' =>
['core' => [],
'default' => [],
'locale_path' => false, // Set to a path to use *instead of* each plugin's own locale subdirectories
'server' => null,
'sslserver' => null,
'path' => null,
'sslpath' => null,
'url_base' => null,
],
'admin' =>
['panels' =>
['site', 'user', 'paths', 'access', 'sessions', 'sitenotice', 'license', 'plugins',
]
],
'singleuser' =>
['enabled' => false,
'admin' => ['panels' => ['site', 'user', 'paths', 'access', 'sessions', 'sitenotice', 'license', 'plugins']],
'single_user' =>
['enabled' => $_ENV['SOCIAL_SITE_PROFILE'] == 'single_user',
'nickname' => null,
],
'robotstxt' =>
['crawldelay' => 0,
'disallow' => ['main', 'settings', 'admin', 'search', 'message'],
'robots_txt' =>
['crawl_delay' => 0,
'disallow' => ['main', 'settings', 'admin', 'search', 'message'],
],
'api' => ['realm' => null],
'api' => ['realm' => null],
'nofollow' =>
['subscribers' => true,
'members' => true,
@ -404,15 +287,12 @@ abstract class DefaultSettings
'external' => 'sometimes', // Options: 'sometimes', 'never', default = 'sometimes'
],
'url' =>
['shortener' => 'internal',
'maxurllength' => 100,
'maxnoticelength' => -1,
['shortener' => 'internal',
'max_url_length' => 100,
'max_notice_length' => -1,
],
'http' => // HTTP client settings when contacting other sites
['ssl_cafile' => false, // To enable SSL cert validation, point to a CA bundle (eg '/usr/lib/ssl/certs/ca-certificates.crt') (this activates "ssl_verify_peer")
'ssl_verify_host' => true, // HTTPRequest2 makes sure this is set to CURLOPT_SSL_VERIFYHOST==2 if using curl
'curl' => false, // Use CURL backend for HTTP fetches if available. (If not, PHP's socket streams will be used.)
'connect_timeout' => 5,
['connect_timeout' => 5,
'timeout' => (int) (ini_get('default_socket_timeout')), // effectively should be this by default already, but this makes it more explicitly configurable for you users .)
'proxy_host' => null,
'proxy_port' => null,

54
src/Util/Common.php
View File

@ -52,4 +52,58 @@ abstract class Common
DB::persist($obj);
DB::flush();
}
/**
* An internal helper function that converts a $size from php.ini for
* file size limit from the 'human-readable' shorthand into a int. If
* $size is empty (the value is not set in php.ini), returns a default
* value (5000000)
*
* @param string|bool $size
* @return int the php.ini upload limit in machine-readable format
*/
public static function size_str_to_int($size): int
{
// `memory_limit` can be -1 and `post_max_size` can be 0
// for unlimited. Consistency.
if (empty($size) || $size === '-1' || $size === '0') {
$size = '3M';
}
$suffix = substr($size, -1);
$size = (int) substr($size, 0, -1);
switch (strtoupper($suffix)) {
case 'P':
$size *= 1024;
// no break
case 'T':
$size *= 1024;
// no break
case 'G':
$size *= 1024;
// no break
case 'M':
$size *= 1024;
// no break
case 'K':
$size *= 1024;
break;
}
return $size;
}
/**
* Uses `size_str_to_int()` to find the smallest value for uploads in php.ini
*
* @return int
*/
public static function get_preferred_php_upload_limit(): int
{
return min(
self::size_str_to_int(ini_get('post_max_size')),
self::size_str_to_int(ini_get('upload_max_filesize')),
self::size_str_to_int(ini_get('memory_limit'))
);
}
}