From 4f85594bec13c5dbf59f57a369513265ff2fa693 Mon Sep 17 00:00:00 2001 From: Hugo Sales Date: Fri, 10 Jul 2020 11:10:18 +0000 Subject: [PATCH] [FORMATTING][DEFAULTS] Fix formatting and remove redundant config defaults --- .php_cs | 2 +- src/Core/DB/DefaultSettings.php | 344 +++++++++++++++----------------- 2 files changed, 158 insertions(+), 188 deletions(-) diff --git a/.php_cs b/.php_cs index 99a0a184a4..2e86b5f39e 100644 --- a/.php_cs +++ b/.php_cs @@ -273,6 +273,6 @@ return PhpCsFixer\Config::create() ->exclude('var') ->exclude('docker') ->exclude('src/Entity') - ->notPath('src/Core/DefaultSettings.php') + ->notPath('src/Core/DB/DefaultSettings.php') ->in(__DIR__) ); diff --git a/src/Core/DB/DefaultSettings.php b/src/Core/DB/DefaultSettings.php index 74a28a3890..1db6c61948 100644 --- a/src/Core/DB/DefaultSettings.php +++ b/src/Core/DB/DefaultSettings.php @@ -41,102 +41,84 @@ abstract class DefaultSettings public static array $defaults; public static function setDefaults() { - self::$defaults = ['site' => ['name' => $_ENV['SOCIAL_SITENAME'] ?? 'Another social instance', - 'server' => $_ENV['SOCIAL_DOMAIN'] ?? 'localhost', - 'notice' => null, // site wide notice text - 'theme' => 'default', - 'logo' => null, - 'language' => 'en', - 'detect_language' => true, - 'languages' => I18nHelper::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) - 'duplicate_time_limit' => 60, // default for same person saying the same thing - 'text_limit' => 1000, // in chars; 0 == no limit - 'x-static-delivery' => null, - ], - 'security' => ['hash_algos' => ['sha1', 'sha256', 'sha512']], // set to null for anything that hash_hmac() can handle (and is in hash_algos()) - 'db' => ['mirror' => null], // TODO implement - 'fix' => ['fancy_urls' => true, // makes sure aliases in WebFinger etc. are not f'd by index.php/ URLs - 'http' => true, // set this to true if you have upgraded your site from http=>https + self::$defaults = [ + 'site' => [ + 'name' => $_ENV['SOCIAL_SITENAME'] ?? 'Another social instance', + 'server' => $_ENV['SOCIAL_DOMAIN'], + 'notice' => null, // site wide notice text + 'theme' => 'default', + 'logo' => null, + 'language' => 'en', + 'detect_language' => true, + 'languages' => I18nHelper::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, + 'register_type' => 'public', + 'nickname' => $_ENV['SOCIAL_ADMIN_NICK'], + '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) + 'duplicate_time_limit' => 60, // default for same person saying the same thing + 'text_limit' => 1000, // in chars; 0 == no limit + 'x_static_delivery' => null, ], - 'queue' => ['enabled' => true, - 'daemon' => false, // Use queuedaemon. Default to false - 'threads' => null, // an empty value here uses processor count to determine - 'subsystem' => false, // default to database, or 'stomp' - 'basename' => '/queue/gnusocial/', - 'control_channel' => '/topic/gnusocial/control', // broadcasts to all queue daemons - 'monitor' => null, // URL to monitor ping endpoint (work in progress) - 'soft_limit' => '90%', // total size or % of memory_limit at which to restart queue threads gracefully - 'spawn_delay' => 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, - '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) - '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) + 'security' => ['hash_algos' => ['sha1', 'sha256', 'sha512']], // set to null for anything that hash_hmac() can handle (and is in hash_algos()) + 'db' => ['mirror' => null], // TODO implement + 'cache' => [ + 'notice_max_count' => 128, ], - 'avatar' => ['server' => null, - 'url_base' => '/avatar/', - 'ssl' => null, - 'dir' => INSTALLDIR . '/file/avatar/', - 'max_size_px' => 300, + 'avatar' => [ + 'server' => null, + 'ssl' => null, + 'dir' => INSTALLDIR . '/file/avatar/', + 'max_size_px' => 300, ], - 'javascript' => ['server' => null, - 'url_base' => '/js/', - 'ssl' => null, - 'bust_frames' => true, + 'javascript' => [ + 'server' => null, + 'ssl' => null, ], - 'attachments' => ['server' => null, - 'url_base' => '/file/', - 'ssl' => null, - 'dir' => INSTALLDIR . '/file/uploads/', - 'supported' => ['application/vnd.oasis.opendocument.chart' => 'odc', - 'application/vnd.oasis.opendocument.formula' => 'odf', - 'application/vnd.oasis.opendocument.graphics' => 'odg', - 'application/vnd.oasis.opendocument.graphics-template' => 'otg', - 'application/vnd.oasis.opendocument.image' => 'odi', - 'application/vnd.oasis.opendocument.presentation' => 'odp', - 'application/vnd.oasis.opendocument.presentation-template' => 'otp', - 'application/vnd.oasis.opendocument.spreadsheet' => 'ods', - 'application/vnd.oasis.opendocument.spreadsheet-template' => 'ots', - 'application/vnd.oasis.opendocument.text' => 'odt', - 'application/vnd.oasis.opendocument.text-master' => 'odm', - 'application/vnd.oasis.opendocument.text-template' => 'ott', - 'application/vnd.oasis.opendocument.text-web' => 'oth', - 'application/pdf' => 'pdf', - 'application/zip' => 'zip', - 'application/x-bzip2' => 'bz2', - 'application/x-go-sgf' => 'sgf', - 'application/xml' => 'xml', - 'application/gpx+xml' => 'gpx', - 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_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', - 'application/ogg' => 'ogx', - 'text/plain' => 'txt', - 'video/mpeg' => 'mpeg', - 'video/mp4' => 'mp4', - 'video/ogg' => 'ogv', - 'video/quicktime' => 'mov', - 'video/webm' => 'webm', + 'attachments' => [ + 'server' => null, + 'ssl' => null, + 'dir' => INSTALLDIR . '/file/uploads/', + 'supported' => [ + 'application/vnd.oasis.opendocument.chart' => 'odc', + 'application/vnd.oasis.opendocument.formula' => 'odf', + 'application/vnd.oasis.opendocument.graphics' => 'odg', + 'application/vnd.oasis.opendocument.graphics-template' => 'otg', + 'application/vnd.oasis.opendocument.image' => 'odi', + 'application/vnd.oasis.opendocument.presentation' => 'odp', + 'application/vnd.oasis.opendocument.presentation-template' => 'otp', + 'application/vnd.oasis.opendocument.spreadsheet' => 'ods', + 'application/vnd.oasis.opendocument.spreadsheet-template' => 'ots', + 'application/vnd.oasis.opendocument.text' => 'odt', + 'application/vnd.oasis.opendocument.text-master' => 'odm', + 'application/vnd.oasis.opendocument.text-template' => 'ott', + 'application/vnd.oasis.opendocument.text-web' => 'oth', + 'application/pdf' => 'pdf', + 'application/zip' => 'zip', + 'application/x-bzip2' => 'bz2', + 'application/x-go-sgf' => 'sgf', + 'application/xml' => 'xml', + 'application/gpx+xml' => 'gpx', + 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_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', + 'application/ogg' => 'ogx', + 'text/plain' => 'txt', + 'video/mpeg' => 'mpeg', + 'video/mp4' => 'mp4', + 'video/ogg' => 'ogv', + 'video/quicktime' => 'mov', + 'video/webm' => 'webm', ], 'file_quota' => Common::get_preferred_php_upload_limit(), 'user_quota' => Common::size_str_to_int('200M'), @@ -146,46 +128,43 @@ abstract class DefaultSettings '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. 'ext_blacklist' => [], - 'filename' => 'hash', 'memory_limit' => '1024M', // PHP memory limit to use temporarily when handling images ], - 'thumbnail' => ['server' => null, - 'url_base' => '/thumb/', - 'ssl' => null, - 'dir' => INSTALLDIR . '/file/thumbnails/', // falls back to File::path('thumb') (equivalent to ['attachments']['dir'] . '/thumb/') - 'crop' => false, // overridden to true if thumb height === null - 'max_size_px' => 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" + 'thumbnail' => [ + 'server' => null, + 'ssl' => null, + 'dir' => INSTALLDIR . '/file/thumbnails/', // falls back to File::path('thumb') (equivalent to ['attachments']['dir'] . '/thumb/') + 'crop' => false, // overridden to true if thumb height === null + 'max_size_px' => 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" ], - 'theme' => ['server' => null, - 'url_base' => '/theme/', - 'ssl' => null, - 'dir' => INSTALLDIR . '/public/theme/', + 'theme' => [ + 'server' => null, + 'ssl' => null, + 'dir' => INSTALLDIR . '/public/theme/', ], - 'plugins' => ['server' => null, - 'url_base' => null, - 'ssl' => null, - 'core' => [], - 'default' => [], - 'locale_path' => null, // Set to a path to use *instead of* each plugin's own locale subdirectories + 'plugins' => [ + 'server' => null, + 'ssl' => null, + 'core' => [], + 'default' => [], + 'locale_path' => null, // Set to a path to use *instead of* each plugin's own locale subdirectories ], - 'license' => ['type' => 'cc', // can be 'cc', 'allrightsreserved', 'private' - 'owner' => null, // can be name of content owner e.g. for enterprise - 'url' => 'https://creativecommons.org/licenses/by/4.0/', - 'title' => 'Creative Commons Attribution 4.0', - 'image' => '/theme/licenses/cc_by_4.0.png', + 'license' => [ + 'type' => 'cc', // can be 'cc', 'allrightsreserved', 'private' + 'owner' => null, // can be name of content owner e.g. for enterprise + 'url' => 'https://creativecommons.org/licenses/by/4.0/', + 'title' => 'Creative Commons Attribution 4.0', + 'image' => '/theme/licenses/cc_by_4.0.png', ], - 'mail' => ['backend' => 'mail', - 'params' => null, - 'domain_check' => true, + 'nickname' => [ + 'blacklist' => ['doc', 'main', 'avatar', 'theme'], + 'featured' => [], ], - 'nickname' => ['blacklist' => ['doc', 'main', 'avatar', 'theme'], - 'featured' => [], - ], - 'profile' => ['banned' => [], + 'profile' => [ 'bio_text_limit' => null, 'allow_nick_change' => false, 'allow_private_stream' => true, // whether to allow setting stream to private ("only followers can read") @@ -194,84 +173,75 @@ abstract class DefaultSettings 'delete' => false, 'move' => false, ], - 'image' => ['jpegquality' => 85], - 'theme_upload' => ['enabled' => true, - 'formats' => ['zip', 'tar', 'gz', 'tar.gz'], ], + 'image' => ['jpegquality' => 85], 'foaf' => ['mbox_sha1sum' => false], - 'public' => ['local_only' => false, - 'blacklist' => [], - 'exclude_sources' => [], - ], - 'throttle' => ['enabled' => true, // whether to throttle posting dents - 'count' => 20, // number of allowed messages in timespan - 'timespan' => 600, // timespan for throttling + 'public' => [ + 'local_only' => false, + 'blacklist' => [], + 'exclude_sources' => [], ], 'invite' => ['enabled' => true], - 'tag' => ['dropoff' => 86400 * 10, // controls weighting based on age - 'cutoff' => 86400 * 90, // only look at notices posted in last 90 days + 'tag' => [ + 'dropoff' => 86400 * 10, // controls weighting based on age + 'cutoff' => 86400 * 90, // only look at notices posted in last 90 days ], - 'popular' => ['dropoff' => 86400 * 10, // controls weighting based on age - 'cutoff' => 86400 * 90, // only look at notices favorited in last 90 days + 'popular' => [ + 'dropoff' => 86400 * 10, // controls weighting based on age + 'cutoff' => 86400 * 90, // only look at notices favorited in last 90 days ], - 'daemon' => ['piddir' => sys_get_temp_dir(), - 'user' => false, - 'group' => false, + 'new_users' => [ + 'default_subscriptions' => null, + 'welcome_user' => null, ], - 'ping' => ['notify' => [], - 'timeout' => 2, + 'linkify' => [ // "bare" below means "without schema", like domain.com vs. https://domain.com + 'bare_domains' => false, // convert domain.com to domain.com ? + 'ipv4' => false, // convert IPv4 addresses to hyperlinks? + 'ipv6' => false, // convert IPv6 addresses to hyperlinks? ], - 'new_users' => ['default_subscriptions' => null, - 'welcome_user' => null, + 'group' => [ + 'max_aliases' => 3, + 'description_limit' => null, ], - 'linkify' => // "bare" below means "without schema", like domain.com vs. https://domain.com - ['bare_domains' => false, // convert domain.com to domain.com ? - 'linkify_ipv4' => false, // convert IPv4 addresses to hyperlinks? - 'linkify_ipv6' => false, // convert IPv6 addresses to hyperlinks? - ], - 'group' => ['max_aliases' => 3, - 'description_limit' => 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' => ['local' => true, 'remote' => true], // equivalent to array() - 'description_limit' => 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' => ['local' => true, 'remote' => true], + 'description_limit' => null, ], 'search' => ['type' => 'like'], 'html_filter' => ['tags' => ['img', 'video', 'audio', 'script']], - 'notice' => ['content_limit' => null, - 'allow_private' => false, // whether to allow users to "check the padlock" to publish notices available for their subscribers. - 'hide_banned' => true, // Whether to hide silenced users from timelines + 'notice' => [ + 'content_limit' => null, + 'allow_private' => false, // whether to allow users to "check the padlock" to publish notices available for their subscribers. + 'hide_banned' => true, // whether to hide silenced users from timelines ], - 'message' => ['content_limit' => null], - 'location' => ['share' => 'user'], - 'admin' => ['panels' => ['site', 'user', 'paths', 'access', 'sessions', 'sitenotice', 'license', 'plugins']], - 'single_user' => ['enabled' => $_ENV['SOCIAL_SITE_PROFILE'] ?? '' == 'single_user', - 'nickname' => null, + 'message' => ['content_limit' => null], + 'location' => ['share' => 'user'], + 'robots_txt' => [ + 'crawl_delay' => 0, + 'disallow' => ['main', 'settings', 'admin', 'search', 'message'], ], - 'robots_txt' => ['crawl_delay' => 0, - 'disallow' => ['main', 'settings', 'admin', 'search', 'message'], + 'nofollow' => [ + 'subscribers' => true, + 'members' => true, + 'peopletag' => true, + 'external' => 'sometimes', // Options: 'sometimes', 'never', default = 'sometimes' ], - 'nofollow' => ['subscribers' => true, - 'members' => true, - 'peopletag' => true, - 'external' => 'sometimes', // Options: 'sometimes', 'never', default = 'sometimes' + 'url_shortener' => [ + 'service' => 'internal', + 'max_url_length' => 100, + 'max_notice_length' => null, ], - 'url_shortener' => ['service' => 'internal', - 'max_url_length' => 100, - 'max_notice_length' => null, + 'http' => [ // HTTP client settings when contacting other sites + 'ssl_ca_file' => '/docker/certbot/files/live/', + '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, + 'proxy_user' => null, + 'proxy_password' => null, + 'proxy_auth_scheme' => null, ], - 'http' => // HTTP client settings when contacting other sites - ['ssl_ca_file' => '/docker/certbot/files/live/', - '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, - 'proxy_user' => null, - 'proxy_password' => null, - 'proxy_auth_scheme' => null, - ], - 'discovery' => ['CORS' => false], // Allow Cross-Origin Resource Sharing for service discovery (host-meta, XRD, etc.) - 'performance' => ['high' => false], // disable some features for higher performance; default false - 'login_command' => ['enabled' => false], + 'discovery' => ['CORS' => false], // Allow Cross-Origin Resource Sharing for service discovery (host-meta, XRD, etc.) ]; self::loadDefaults($_ENV['APP_ENV'] == 'prod');