first commit

administrator/components/com_osmap/library/Alledia/OSMap/Plugin/Base.php

@@ -0,0 +1,127 @@
+<?php
+/**
+ * @package   OSMap
+ * @contact   www.joomlashack.com, help@joomlashack.com
+ * @copyright 2007-2014 XMap - Joomla! Vargas - Guillermo Vargas. All rights reserved.
+ * @copyright 2016-2024 Joomlashack.com. All rights reserved.
+ * @license   https://www.gnu.org/licenses/gpl.html GNU/GPL
+ *
+ * This file is part of OSMap.
+ *
+ * OSMap 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.
+ *
+ * OSMap 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 OSMap.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+namespace Alledia\OSMap\Plugin;
+
+use Alledia\Framework\Exception;
+use Joomla\CMS\Language\Text;
+use Joomla\CMS\Plugin\CMSPlugin;
+
+defined('_JEXEC') or die();
+
+abstract class Base extends CMSPlugin
+{
+    /**
+     * @var int
+     */
+    protected static $memoryLimit = null;
+
+    /**
+     * Minimum memory in MB required to continue on sites with limited memory
+     *
+     * @var int
+     */
+    protected static $memoryMinimum = 4;
+
+    /**
+     * @inheritDoc
+     */
+    public function __construct(&$subject, $config = [])
+    {
+        require_once JPATH_ADMINISTRATOR . '/components/com_osmap/include.php';
+
+        parent::__construct($subject, $config);
+    }
+
+    /**
+     * Set memory limit to unlimited. If unable to do so,
+     * we'll want to check that we have enough memory left to continue,
+     * so we can fail gracefully
+     *
+     * @return void
+     */
+    protected static function fixMemoryLimit()
+    {
+        if (static::$memoryLimit === null) {
+            $limit = @ini_set('memory_limit', -1);
+
+            if (empty($limit)) {
+                $mags  = [
+                    'K' => 1024,
+                    'M' => 1024 * 1024,
+                    'G' => 1024 * 1024 * 1024
+                ];
+                $limit = ini_get('memory_limit');
+                $regex = sprintf('/(\d*)([%s])/', join(array_keys($mags)));
+                if (preg_match($regex, $limit, $match)) {
+                    $limit = $match[1] * $mags[$match[2]];
+                }
+
+                static::$memoryLimit   = $limit;
+                static::$memoryMinimum *= $mags['M'];
+            }
+        }
+    }
+
+    /**
+     * Check to see if we're about to run out of memory. If things get too tight
+     * all we can do is throw an informative message or redirect somewhere else
+     * that isn't an OSMap page
+     *
+     * @TODO: Decide whether to implement the redirect option
+     *
+     * @return void
+     * @throws Exception
+     */
+    protected static function checkMemory()
+    {
+        if (static::$memoryLimit === null) {
+            static::fixMemoryLimit();
+        }
+
+        if (static::$memoryLimit && (static::$memoryLimit - memory_get_usage(true) < static::$memoryMinimum)) {
+            $message = Text::sprintf('COM_OSMAP_WARNING_OOM', get_called_class());
+            throw new Exception($message, 500);
+        }
+    }
+
+    /**
+     * @param string $url
+     *
+     * @return string
+     */
+    protected static function getViewFromUrl(string $url): string
+    {
+        $linkUrl = parse_url($url);
+        if (isset($linkUrl['query'])) {
+            parse_str($linkUrl['query'], $linkQuery);
+
+            if (isset($linkQuery['view'])) {
+                return $linkQuery['view'];
+            }
+        }
+
+        return '';
+    }
+}

administrator/components/com_osmap/library/Alledia/OSMap/Plugin/ContentInterface.php

@@ -0,0 +1,73 @@
+<?php
+/**
+ * @package   OSMap
+ * @contact   www.joomlashack.com, help@joomlashack.com
+ * @copyright 2007-2014 XMap - Joomla! Vargas - Guillermo Vargas. All rights reserved.
+ * @copyright 2016-2024 Joomlashack.com. All rights reserved.
+ * @license   https://www.gnu.org/licenses/gpl.html GNU/GPL
+ *
+ * This file is part of OSMap.
+ *
+ * OSMap 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.
+ *
+ * OSMap 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 OSMap.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+namespace Alledia\OSMap\Plugin;
+
+use Alledia\OSMap\Sitemap\Collector;
+use Alledia\OSMap\Sitemap\Item;
+use Joomla\Registry\Registry;
+
+defined('_JEXEC') or die();
+
+
+interface ContentInterface
+{
+    /**
+     * Returns the unique instance of the plugin
+     *
+     * @return object
+     */
+    public static function getInstance();
+
+    /**
+     * Returns the element of the component which this plugin supports.
+     *
+     * @return string
+     */
+    public function getComponentElement();
+
+    /**
+     * This function is called before a menu item is used. We use it to set the
+     * proper uniqueid for the item
+     *
+     * @param Item     $node   Menu item to be "prepared"
+     * @param Registry $params The extension params
+     *
+     * @return void
+     * @since  1.2
+     */
+    public static function prepareMenuItem($node, $params);
+
+    /**
+     * Expands a com_content menu item
+     *
+     * @param Collector $collector
+     * @param Item      $parent
+     * @param Registry  $params
+     *
+     * @return void
+     * @since  1.0
+     */
+    public static function getTree($collector, $parent, $params);
+}