sbrl-github/Pepperminty-Wiki
sbrl-github/Pepperminty-Wiki
1
0
Fork 0
mirror of https://github.com/sbrl/Pepperminty-Wiki.git synced 2024-11-21 16:13:00 +00:00
Code Activity

Added automatic system requirements indicator to first run

Browse source
This commit is contained in:
Starbeamrainbowlabs 2021-08-06 01:50:08 +01:00
parent e7b3f5e0d0
commit ba70f74a96
Signed by: sbrl
GPG key ID: 1BE5172E637709C2
2 changed files with 49 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
Changelog.md
View file

@ -9,6 +9,7 @@ This file holds the changelog for Pepperminty Wiki. This is the master list of t
- This allows for having a "create new page" button in your navigation links - e.g. edit `nav_links`, `nav_links_extra`, or `nav_links_bottom` in your `peppermint.json` and add something like `[ "+", "index.php?action=edit&unknownpagename=yes" ]`.
- XML sitemap support with the new `page-sitemap` module (manual setup required for crawlers to notice it: see [the documentation](https://github.com/sbrl/Pepperminty-Wiki/blob/master/docs/02-Features.md#whats-this-about-manual-setup-for-the-sitemap))
- Experimental support for transparent handling of `[display text](./Page Name.md)` style internal links (disabled by default: enable the `parser_mangle_external_links` setting and delete the `._cache` directory to enable)
- Added automatic system requirements indicator to first run (checks for various PHP extensions required for various different functions) - does not block you from proceeding, but does assist in first-time system configuration
## Changed
- Updated the [configuration guide](https://starbeamrainbowlabs.com/labs/peppermint/peppermint-config-info.php) to include count of how many settings we have

50
modules/feature-firstrun.php
View file

@ -6,7 +6,7 @@
register_module([
"name" => "First run wizard",
"version" => "0.1.1",
"version" => "0.2",
"author" => "Starbeamrainbowlabs",
"description" => "Displays a special page to aid in setting up a new wiki for the first time.",
"id" => "feature-firstrun",
@ -75,11 +75,27 @@ register_module([
// TODO: Add option to configure theme auto-update here - make sure it doesn't do anything until configuration it complete!
$system_checks = implode("\n\t\t\t", array_map(function($check) {
$result = "<li>";
if(!$check[0]) $result .= "<strong>";
$result .= $check[0] ? "&#x2705;" : ($check[2] === "optional" ? "&#x26a0;&#xfe0f;" : "&#x274c;");
$result .= " {$check[1]}";
if(!$check[0]) $result .= "</strong>";
return $result;
}, do_system_checks()));
$result = "<h1>Welcome!</h1>
<p>Welcome to Pepperminty Wiki.</p>
<p>Fill out the below form to get your wiki up and running!</p>
<p>Optionally, <a target='_blank' href='https://starbeamrainbowlabs.com/blog/viewtracker.php?action=record&post-id=pepperminty-wiki/$version&format=text'>click this link</a> to say hi and let Starbeamrainbowlabs know that you're setting up a new Pepperminty Wiki $version instance.</p>
<form method='post' action='?action=firstrun-complete'>
<fieldset>
<legend>System requirements</legend>
<ul>
$system_checks
</ul>
</fieldset>
<fieldset>
<legend>Authorisation</legend>
@ -104,7 +120,7 @@ register_module([
<input type='password' id='password-again' name='password-again' required />
</fieldset>
<fieldset>
<legend>Wiki Details</legend>
<legend>Wiki details</legend>
<label for='wiki-name'>Wiki Name:</label>
<input type='text' id='wiki-name' name='wiki-name' placeholder=\"e.g. Bob's Rockets Compendium\" required />
@ -203,3 +219,33 @@ register_module([
});
}
]);
function do_system_checks() {
$checks = [
function_exists("mb_strpos")
? [true, "php-mbstring is installed"]
: [false, "php-mbstring is not installed"],
class_exists("Transliterator") && class_exists("Collator")
? [true, "php-intl is installed for item sorting, search indexing, and sending non-utf8 emails"]
: [false, "php-intl is not installed (needed for item sorting, search indexing, and sending non-utf8 emails)"]
];
if(module_exists("feature-upload")) {
$checks[] = class_exists("Imagick")
? [true, "php-imagick is installed for preview generation"]
: [false, "php-imagick is not installed (needed for image preview generation)", "optional"];
$checks[] = function_exists("finfo_file")
? [true, "php-fileinfo is installed for upload file type checking"]
: [false, "php-fileinfo is not installed (needed for file type checking on uploads)", "optional"];
}
if(module_exists("page-export"))
$checks[] = class_exists("ZipArchive")
? [true, "php-zip is installed for compressing exports"]
: [false, "php-zip is not install (needed for compressing exports)", "optional"];
if(module_exists("lib-search-engine") or module_exists("feature-search-didyoumean"))
$checks[] = extension_loaded("sqlite3")
? [true, "php-sqlite3 is installed for search indexing"]
: [false, "php-sqlite3 is not installed (needed for search indexing)", "optional"];
return $checks;
}