Merge pull request #25 from jdarwood007/cleanUp

Finish support for 1.39 and refactor code

Author: jdarwood007

.gitattributes

@@ -1,2 +1,11 @@
 # Force our line endings to be LF, even for Windows
-* text eol=lf
+* text eol=lf
+
+# Set certain files to be binary
+*.png binary
+*.jpg binary
+*.gif binary
+*.tgz binary
+*.zip binary
+*.tar.gz binary
+*.ttf binary

.github/workflows/Syntax-Check.yml

@@ -8,7 +8,7 @@ jobs:
     strategy:
       matrix:
         operating-system: [ ubuntu-latest ]
-        php: [ '7.0', '7.1', '7.2', '7.3', '7.4', '8.0', '8.1' ]
+        php: [ '7.0', '7.1', '7.2', '7.3', '7.4', '8.0', '8.1', '8.2' ]
     name: PHP ${{ matrix.php }} Syntax Check
     steps:
       - uses: actions/checkout@master

README.md

@@ -1,25 +1,21 @@
 ## smfCurve - Curve Skin for MediaWiki
-
 This is Mediawiki Skin based on Curve for SMF development repository.
 Parts of this theme are licensed under [BSD 3-clause license](https://www.opensource.org/licenses/BSD-3-Clause), Others are [GPL](https://www.gnu.org/copyleft/gpl.html)
 
 #### Versions
-* **1.x**: Compatible with SMF2.0
 * **2.x**: Compatible with SMF2.1
+* **1.x**: Compatible with SMF2.0 [No longer actively developed]
 
 #### Branches organization:
-* ***master*** - main branch, v2.0 (smfCurve2) compatible with **SMF2.1**, Supporting MediaWiki 1.39+
+* ***master*** - main branch, v2.1 (smfCurve2) compatible with **SMF2.1**, Supporting MediaWiki 1.39+
 * ***2.0*** - main branch, v2.0 (smfCurve2) compatible with **SMF2.1**, Supporting MediaWiki 1.31-1.35
-* ***1.0*** - for old MediaWiki installs (Prior to 1.23)
-* ***1.1*** - for MediaWiki 1.23 (LTS)
-* ***1.2*** - for MediaWiki 1.25+
-* ***1.3*** - for MediaWiki 1.27 (LTS)
 * ***1.4*** - for MediaWiki 1.31-1.35 (LTS)
-
-[Installing](https://github.com/SimpleMachines/smfcurve/wiki/Installing) - [Upgrading](https://github.com/SimpleMachines/smfcurve/wiki/Upgrading)
+* ***1.3*** - for MediaWiki 1.27 (LTS)
+* ***1.2*** - for MediaWiki 1.25+
+* ***1.1*** - for MediaWiki 1.23 (LTS)
+* ***1.0*** - for old MediaWiki installs (Prior to 1.23)
 
 #### Notes:
-
 Feel free to fork this repository and make your desired changes.
 
 Please see the [Developer's Certificate of Origin](https://github.com/SimpleMachines/smfcurve/blob/master/DCO.txt) in the repository:
@@ -29,7 +25,56 @@ by signing off your contributions, you acknowledge that you can and do license y
 * fork the repository. If you are not used to Github, please check out [fork a repository](http://help.github.com/fork-a-repo).
 * branch your repository, to commit the desired changes.
 * sign-off your commits, to acknowledge your submission under the license of the project.
-* an easy way to do so, is to define an alias for the git commit command, which includes -s switch (reference: [How to create Git aliases](http://githacks.com/post/1168909216/how-to-create-git-aliases))
+* an easy way to do so, is to define an alias for the git commit command, which includes -s switch (reference: [How to create Git aliases](https://githacks.com/post/1168909216/how-to-create-git-aliases))
 * send a pull request to us.
 
 Finally, feel free to play around. That's what we're doing. ;)
+
+## Installing
+Add to your LocalSettings.php
+```
+wfLoadSkin( 'smfcurve2' );
+```
+
+To set as the default skin:
+```
+$wgDefaultSkin = "smfcurve2";
+```
+
+## Customizing
+We provide a few simple and more advanced methods to customizing the skin.
+
+### Simple
+
+#### Adding the forum main menu
+Add to your LocalSettings.php (After your wfLoadSkin line)
+```
+$wgsmfRoot = '/path/to/forum';
+$wgshowSMFmenu = true;
+```
+
+#### Adding the Wiki logo where the SMF logo shows
+```
+$wguseLogoImage = true;
+```
+
+#### Adding the search to the sidebar
+```
+$wguseSideSearchBox = true;
+```
+
+### Advanced
+To do more advance customizing, several files can be changed.  However they are designed to allow extending the base skin.
+
+First set in your LocalSettings.php
+```
+$wgDefaultSkin = "smfcurve2custom";
+```
+
+You can modify the following files depending on your needs:
+- /inclues/smfCurve2SkinCustom.php
+- /inclues/smfCurve2TemplateCustom.php
+- /resources/script/custom.js
+- /resources/css/custom.css
+
+We have included some sample code to show how modifications may be made.

includes/Skinsmfcurve2.php renamed to includes/smfCurve2Skin.php

@@ -17,7 +17,7 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * https://www.gnu.org/copyleft/gpl.html
  *
- * Copyright 2022, Simple Machines and Individual Contributors
+ * Copyright 2023, Simple Machines and Individual Contributors
  *
  * Based On smfcurve by Labradoodle-360
  *
@@ -34,7 +34,7 @@
  *
  * @ingroup Skins
  */
-class Skinsmfcurve2 extends SkinTemplate
+class smfCurve2Skin extends SkinTemplate
 {	
 	/**
 	 * @inheritDoc

includes/smfCurve2SkinCustom.php

@@ -0,0 +1,88 @@
+<?php
+/**
+ * SMF Curve 2
+ *
+ ** This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * https://www.gnu.org/copyleft/gpl.html
+ *
+ * Copyright 2023, Simple Machines and Individual Contributors
+ *
+ * Based On smfcurve by Labradoodle-360
+ *
+ * Images under separate license
+ * @license https://www.simplemachines.org/about/smf/license.php BSD
+ */
+
+namespace MediaWiki\Skin\smfcurve2;
+
+use SkinTemplate;
+
+/*
+ * This is a sample of how to extend and modify the main template, without requiring changes to the main template.
+ * Keeps your customizations separated from the logic that builds the base theme
+*/
+class smfCurve2SkinCustom extends smfCurve2Skin
+{
+	public function __construct(
+		array $options = []
+	) {
+		$out = $this->getOutput();
+		/**
+		* Some shortcuts to more commonly used/needed methods.
+		* This is a incomplete list, see /includes/OutputPage.php for the complete list.
+		*
+		* $out->addStyle
+		 * 		@param string $style URL to the file
+		 * 		@param string $media To specify a media type, 'screen', 'printable', 'handheld' or any.
+		 * 		@param string $condition For IE conditional comments, specifying an IE version
+		 * 		@param string $dir Set to 'rtl' or 'ltr' for direction-specific sheets
+		 *
+		 * $out->addInlineStyle
+		 * 		@param mixed $style_css Inline CSS
+		 * 		@param string $flip Set to 'flip' to flip the CSS if needed
+		 *
+		 * $out->addScript
+		 * 	!!! Add your own <script> tags, added just before </body>.
+	 	 * 		@param string $script Raw HTML
+		 *
+		 * $out->addScriptFile
+		 *  !!! Added just before </body>
+		 * 		@param string $file URL to file (absolute path, protocol-relative, or full url)
+		 * 		@param string|null $unused Previously used to change the cache-busting query parameter
+		 *
+		 * $out->addInlineScript
+		 *  !!! Wrapped in <script> tags, no additional paramters. Added just before </body>
+		 * 		@param string $script JavaScript text, no script tags
+		 *
+		 * $out->addMeta
+		 * 		@param string $name Name of the meta tag
+		 * 		@param string $val Value of the meta tag
+		 *
+		 * $out->addLink
+		 * 		@param array $linkarr Associative array of attributes.
+		 *
+		 * $out->setCanonicalUrl
+		 * 		@param string $url
+		 *
+		 * $out->addBodyClasses
+		 * 		@param string|string[] $classes One or more classes to add
+		 */
+
+		// Add some additional css.
+		$out->addStyle('https://fonts.googleapis.com/css2?family=Source+Sans+Pro&display=swap', 'screen', '');
+
+		parent::__construct( $options );
+	}
+}

includes/smfCurve2Template.php

@@ -17,7 +17,7 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * https://www.gnu.org/copyleft/gpl.html
  *
- * Copyright 2022, Simple Machines and Individual Contributors
+ * Copyright 2023, Simple Machines and Individual Contributors
  *
  * Based On smfcurve by Labradoodle-360
  *
@@ -48,7 +48,7 @@
  * And Set $showSMFmenu to true in line 94
  */
 //	require_once("path/to/SSI.php");
-class smfcurve2Template extends BaseTemplate
+class smfCurve2Template extends BaseTemplate
 {
 	/** @var array */
 	protected $pileOfTools;
@@ -78,7 +78,7 @@ class smfcurve2Template extends BaseTemplate
 	/**
 	 * @return Config
 	 */
-	private function getConfig() {
+	protected function getConfig() {
 		return $this->config;
 	}
 
@@ -89,13 +89,34 @@ private function setupCustomization()
 	{
 		global $wgRequest;
 
-		$ssi = $this->getConfig()->get('smfRoot')['value'];
-		if (!empty($ssi) && file_exists($ssi . '/SSI.php'))
+		// SMF's massive globals.
+		global $maintenance, $msubject, $mmessage, $mbname, $language;
+		global $boardurl, $boarddir, $sourcedir, $webmaster_email, $cookiename, $db_character_set;
+		global $db_type, $db_server, $db_name, $db_user, $db_prefix, $db_persist, $db_error_send, $db_last_error, $db_show_debug;
+		global $db_connection, $db_port, $modSettings, $context, $sc, $user_info, $topic, $board, $txt;
+		global $smcFunc, $ssi_db_user, $scripturl, $ssi_db_passwd, $db_passwd, $cache_enable, $cachedir;
+		global $auth_secret, $cache_accelerator, $cache_memcached;
+
+		// Add to your LocalSettings: $wgsmfRoot = '';
+		// If you have the ForumSSoProvider installed you could do: $wgsmfRoot = $wgFSPPath;
+		$ssi = $this->getConfig()->get('smfRoot');
+		if (!empty($ssi) && is_string($ssi) && file_exists($ssi . '/SSI.php'))
+		{
+			include($ssi . '/Settings.php');
 			require_once($ssi . '/SSI.php');
+		}
+
+		// Add to your LocalSettings: $wgshowSMFmenu = true;
+		if (is_bool($this->getConfig()->get('showSMFmenu')))
+			$this->showSMFmenu = $this->getConfig()->get('showSMFmenu');
+
+		// Add to your LocalSettings: $wguseLogoImage = true;
+		if (is_bool($this->getConfig()->get('useLogoImage')))
+			$this->useLogoImage = $this->getConfig()->get('useLogoImage');
 
-		$this->showSMFmenu = $this->getConfig()->get('showSMFmenu')['value'];
-		$this->useLogoImage = $this->getConfig()->get('useLogoImage')['value'];
-		$this->useSideSearchBox = $this->getConfig()->get('useSideSearchBox')['value'];
+		// Add to your LocalSettings: $wguseSideSearchBox = true;
+		if (is_bool($this->getConfig()->get('useSideSearchBox')))
+			$this->useSideSearchBox = $this->getConfig()->get('useSideSearchBox');
 
 		$this->skin = $skin = $this->data['skin'];
 

includes/smfCurve2TemplateCustom.php

@@ -0,0 +1,72 @@
+<?php
+/**
+ * SMF Curve 2
+ *
+ ** This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * https://www.gnu.org/copyleft/gpl.html
+ *
+ * Copyright 2023, Simple Machines and Individual Contributors
+ *
+ * Based On smfcurve by Labradoodle-360
+ *
+ * Images under separate license
+ * @license https://www.simplemachines.org/about/smf/license.php BSD
+ */
+
+namespace MediaWiki\Skin\smfcurve2;
+
+use BaseTemplate;
+use File;
+use Html;
+use Linker;
+use MediaWiki\MediaWikiServices;
+use MWDebug;
+use ResourceLoaderSkinModule;
+use Sanitizer;
+use SpecialPage;
+use Xml;
+use Hooks;
+Use RequestContext;
+
+/*
+ * This is a sample of how to extend and modify the main template, without requiring changes to the main template.
+ * Keeps your customizations separated from the logic that builds the base theme
+*/
+class smfCurve2TemplateCustom extends smfCurve2Template
+{
+	public function customTopSection()
+	{
+		// Only show the user page and preferences.
+		// Additional options removed: ['uls', 'mytalk', 'watchlist', 'mycontris']
+		$this->userMenu(['userpage', 'preferences']);
+
+		// Split the menu.
+		echo '<div class="floatright">';
+		$this->userMenu(['userpage', 'preferences'], true, 'ue');
+		echo '</div>';
+
+	}
+
+	public function customPageFooterExtra()
+	{
+		echo '
+			<div class="clear">
+				<ul>
+					<li class="copyright">Copyright &copy; ' . date('Y') . ' All Rights Reserved.</li>
+					<li class="floatright">Page created in ', sprintf('%01.3f', microtime(true) - $_SERVER['REQUEST_TIME_FLOAT']), ' seconds.</li>
+				</ul>
+			</div>';
+	}
+}

resources/css/custom.css

@@ -0,0 +1,14 @@
+.align_right
+{
+	float: right;
+}
+
+#usermenuextra .genericmenu #top_info
+{
+	padding: 0;
+}
+
+#usermenuextra #pt-uls .uls-trigger
+{
+	padding-top: 0.2em !important;
+}