init

joomla_data/modules/mod_random_image/mod_random_image.xml

@@ -0,0 +1,81 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<extension type="module" client="site" method="upgrade">
+	<name>mod_random_image</name>
+	<author>Joomla! Project</author>
+	<creationDate>2006-07</creationDate>
+	<copyright>(C) 2006 Open Source Matters, Inc.</copyright>
+	<license>GNU General Public License version 2 or later; see LICENSE.txt</license>
+	<authorEmail>admin@joomla.org</authorEmail>
+	<authorUrl>www.joomla.org</authorUrl>
+	<version>3.0.0</version>
+	<description>MOD_RANDOM_IMAGE_XML_DESCRIPTION</description>
+	<namespace path="src">Joomla\Module\RandomImage</namespace>
+	<files>
+		<folder module="mod_random_image">services</folder>
+		<folder>src</folder>
+		<folder>tmpl</folder>
+	</files>
+	<languages>
+		<language tag="en-GB">language/en-GB/mod_random_image.ini</language>
+		<language tag="en-GB">language/en-GB/mod_random_image.sys.ini</language>
+	</languages>
+	<help key="Site_Modules:_Random_Image" />
+	<config>
+		<fields name="params">
+			<fieldset name="basic">
+				<field
+					name="type"
+					type="text"
+					label="MOD_RANDOM_IMAGE_FIELD_TYPE_LABEL"
+					default="jpg"
+				/>
+
+				<field
+					name="folder"
+					type="text"
+					label="MOD_RANDOM_IMAGE_FIELD_FOLDER_LABEL"
+					validate="filePath"
+				/>
+
+				<field
+					name="link"
+					type="text"
+					label="MOD_RANDOM_IMAGE_FIELD_LINK_LABEL"
+				/>
+
+				<field
+					name="width"
+					type="number"
+					label="MOD_RANDOM_IMAGE_FIELD_WIDTH_LABEL"
+					default="100"
+					filter="integer"
+				/>
+
+				<field
+					name="height"
+					type="number"
+					label="MOD_RANDOM_IMAGE_FIELD_HEIGHT_LABEL"
+					filter="integer"
+				/>
+
+			</fieldset>
+			<fieldset name="advanced">
+				<field
+					name="layout"
+					type="modulelayout"
+					label="JFIELD_ALT_LAYOUT_LABEL"
+					class="form-select"
+					validate="moduleLayout"
+				/>
+
+				<field
+					name="moduleclass_sfx"
+					type="textarea"
+					label="COM_MODULES_FIELD_MODULECLASS_SFX_LABEL"
+					rows="3"
+					validate="CssIdentifier"
+				/>
+			</fieldset>
+		</fields>
+	</config>
+</extension>

joomla_data/modules/mod_random_image/services/provider.php

@@ -0,0 +1,41 @@
+<?php
+
+/**
+ * @package     Joomla.Site
+ * @subpackage  mod_random_image
+ *
+ * @copyright   (C) 2025 Open Source Matters, Inc. <https://www.joomla.org>
+ * @license     GNU General Public License version 2 or later; see LICENSE.txt
+ */
+
+\defined('_JEXEC') or die;
+
+use Joomla\CMS\Extension\Service\Provider\HelperFactory;
+use Joomla\CMS\Extension\Service\Provider\Module;
+use Joomla\CMS\Extension\Service\Provider\ModuleDispatcherFactory;
+use Joomla\DI\Container;
+use Joomla\DI\ServiceProviderInterface;
+
+/**
+ * The random image module service provider.
+ *
+ * @since  5.4.0
+ */
+return new class () implements ServiceProviderInterface {
+    /**
+     * Registers the service provider with a DI container.
+     *
+     * @param   Container  $container  The DI container.
+     *
+     * @return  void
+     *
+     * @since   5.4.0
+     */
+    public function register(Container $container)
+    {
+        $container->registerServiceProvider(new ModuleDispatcherFactory('\\Joomla\\Module\\RandomImage'));
+        $container->registerServiceProvider(new HelperFactory('\\Joomla\\Module\\RandomImage\\Site\\Helper'));
+
+        $container->registerServiceProvider(new Module());
+    }
+};

joomla_data/modules/mod_random_image/src/Dispatcher/Dispatcher.php

@@ -0,0 +1,49 @@
+<?php
+
+/**
+ * @package     Joomla.Site
+ * @subpackage  mod_random_image
+ *
+ * @copyright   (C) 2025 Open Source Matters, Inc. <https://www.joomla.org>
+ * @license     GNU General Public License version 2 or later; see LICENSE.txt
+ */
+
+namespace Joomla\Module\RandomImage\Site\Dispatcher;
+
+use Joomla\CMS\Dispatcher\AbstractModuleDispatcher;
+use Joomla\CMS\Helper\HelperFactoryAwareInterface;
+use Joomla\CMS\Helper\HelperFactoryAwareTrait;
+
+// phpcs:disable PSR1.Files.SideEffects
+\defined('_JEXEC') or die;
+// phpcs:enable PSR1.Files.SideEffects
+
+/**
+ * Dispatcher class for mod_random_image
+ *
+ * @since  5.4.0
+ */
+class Dispatcher extends AbstractModuleDispatcher implements HelperFactoryAwareInterface
+{
+    use HelperFactoryAwareTrait;
+
+    /**
+     * Returns the layout data.
+     *
+     * @return  array
+     *
+     * @since   5.4.0
+     */
+    protected function getLayoutData()
+    {
+        $data = parent::getLayoutData();
+
+        $helper         = $this->getHelperFactory()->getHelper('RandomImageHelper');
+        $data['link']   = $data['params']->get('link');
+        $folder         = $helper->getSanitizedFolder($data['params']);
+        $data['images'] = $helper->getImagesFromFolder($data['params'], $folder);
+        $data['image']  = $helper->getImage($data['params'], $data['images']);
+
+        return $data;
+    }
+}

joomla_data/modules/mod_random_image/src/Helper/RandomImageHelper.php

@@ -0,0 +1,218 @@
+<?php
+
+/**
+ * @package     Joomla.Site
+ * @subpackage  mod_random_image
+ *
+ * @copyright   (C) 2006 Open Source Matters, Inc. <https://www.joomla.org>
+ * @license     GNU General Public License version 2 or later; see LICENSE.txt
+ */
+
+namespace Joomla\Module\RandomImage\Site\Helper;
+
+use Joomla\CMS\Uri\Uri;
+use Joomla\Registry\Registry;
+use Joomla\String\StringHelper;
+
+// phpcs:disable PSR1.Files.SideEffects
+\defined('_JEXEC') or die;
+// phpcs:enable PSR1.Files.SideEffects
+
+/**
+ * Helper for mod_random_image
+ *
+ * @since  1.5
+ */
+class RandomImageHelper
+{
+    /**
+     * Retrieves a random image
+     *
+     * @param   Registry  &$params  module parameters object
+     * @param   array     $images   list of images
+     *
+     * @return  mixed
+     *
+     * @since   5.4.0
+     */
+    public function getImage(Registry &$params, array $images): mixed
+    {
+        $width  = $params->get('width', 100);
+        $height = $params->get('height', null);
+
+        $i = \count($images);
+
+        if ($i === 0) {
+            return null;
+        }
+
+        $random = mt_rand(0, $i - 1);
+        $image  = $images[$random];
+        $size   = getimagesize(JPATH_BASE . '/' . $image->folder . '/' . $image->name);
+
+        if ($size[0] < $width) {
+            $width = $size[0];
+        }
+
+        $coeff = $size[0] / $size[1];
+
+        if ($height === null) {
+            $height = (int) ($width / $coeff);
+        } else {
+            $newheight = min($height, (int) ($width / $coeff));
+
+            if ($newheight < $height) {
+                $height = $newheight;
+            } else {
+                $width = $height * $coeff;
+            }
+        }
+
+        $image->width  = $width;
+        $image->height = $height;
+        $image->folder = str_replace('\\', '/', $image->folder);
+
+        return $image;
+    }
+
+    /**
+     * Retrieves images from a specific folder
+     *
+     * @param   Registry  &$params  module params
+     * @param   string    $folder   folder to get the images from
+     *
+     * @return  array
+     *
+     * @since   5.4.0
+     */
+    public function getImagesFromFolder(Registry &$params, string $folder): array
+    {
+        $type       = $params->get('type', 'jpg');
+        $extensions = array_map('trim', explode(',', $type));
+
+        // Normalize to lowercase and strip leading dots
+        $extensions = array_map(function ($ext) {
+            return ltrim(strtolower($ext), '.');
+        }, $extensions);
+
+        $files  = [];
+        $images = [];
+
+        $dir = JPATH_BASE . '/' . $folder;
+
+        // Check if directory exists
+        if (is_dir($dir)) {
+            if ($handle = opendir($dir)) {
+                while (false !== ($file = readdir($handle))) {
+                    if ($file !== '.' && $file !== '..' && $file !== 'CVS' && $file !== 'index.html') {
+                        $files[] = $file;
+                    }
+                }
+            }
+
+            closedir($handle);
+
+            $i = 0;
+
+            foreach ($files as $img) {
+                if (is_dir($dir . '/' . $img)) {
+                    continue;
+                }
+
+                $ext = pathinfo($img, PATHINFO_EXTENSION);
+
+                if (\in_array(strtolower($ext), $extensions, true)) {
+                    $images[$i]         = new \stdClass();
+                    $images[$i]->name   = $img;
+                    $images[$i]->folder = $folder;
+                    $i++;
+                }
+            }
+        }
+
+        return $images;
+    }
+
+    /**
+     * Get sanitized folder
+     *
+     * @param   Registry  &$params  module params objects
+     *
+     * @return  mixed
+     *
+     * @since   5.4.0
+     */
+    public function getSanitizedFolder(Registry &$params): mixed
+    {
+        $folder   = $params->get('folder');
+        $liveSite = Uri::base();
+
+        // If folder includes livesite info, remove
+        if (StringHelper::strpos($folder, $liveSite) === 0) {
+            $folder = str_replace($liveSite, '', $folder);
+        }
+
+        // If folder includes absolute path, remove
+        if (StringHelper::strpos($folder, JPATH_SITE) === 0) {
+            $folder = str_replace(JPATH_BASE, '', $folder);
+        }
+
+        return str_replace(['\\', '/'], DIRECTORY_SEPARATOR, $folder);
+    }
+
+    /**
+     * Retrieves a random image
+     *
+     * @param   Registry  &$params  module parameters object
+     * @param   array     $images   list of images
+     *
+     * @return  mixed
+     *
+     * @deprecated 5.4.0 will be removed in 7.0
+     *             Use the non-static method getImage
+     *             Example: Factory::getApplication()->bootModule('mod_random_image', 'site')
+     *                            ->getHelper('RandomImageHelper')
+     *                            ->getImage($params, $images)
+     */
+    public static function getRandomImage(&$params, $images)
+    {
+        return (new self())->getImage($params, $images);
+    }
+
+    /**
+     * Retrieves images from a specific folder
+     *
+     * @param   Registry  &$params  module params
+     * @param   string    $folder   folder to get the images from
+     *
+     * @return  array
+     *
+     * @deprecated 5.4.0 will be removed in 7.0
+     *             Use the non-static method getImagesFromFolder
+     *             Example: Factory::getApplication()->bootModule('mod_random_image', 'site')
+     *                            ->getHelper('RandomImageHelper')
+     *                            ->getImagesFromFolder($params, $folder)
+     */
+    public static function getImages(&$params, $folder)
+    {
+        return (new self())->getImagesFromFolder($params, $folder);
+    }
+
+    /**
+     * Get sanitized folder
+     *
+     * @param   Registry  &$params  module params objects
+     *
+     * @return  mixed
+     *
+     * @deprecated 5.4.0 will be removed in 7.0
+     *             Use the non-static method getSanitizedFolder
+     *             Example: Factory::getApplication()->bootModule('mod_random_image', 'site')
+     *                            ->getHelper('RandomImageHelper')
+     *                            ->getSanitizedFolder($params)
+     */
+    public static function getFolder(&$params)
+    {
+        return (new self())->getSanitizedFolder($params);
+    }
+}

joomla_data/modules/mod_random_image/tmpl/default.php

@@ -0,0 +1,31 @@
+<?php
+
+/**
+ * @package     Joomla.Site
+ * @subpackage  mod_random_image
+ *
+ * @copyright   (C) 2006 Open Source Matters, Inc. <https://www.joomla.org>
+ * @license     GNU General Public License version 2 or later; see LICENSE.txt
+ */
+
+defined('_JEXEC') or die;
+
+use Joomla\CMS\HTML\HTMLHelper;
+use Joomla\CMS\Language\Text;
+
+if (!count($images)) {
+    echo Text::_('MOD_RANDOM_IMAGE_NO_IMAGES');
+
+    return;
+}
+?>
+
+<div class="mod-randomimage random-image">
+<?php if ($link) : ?>
+<a href="<?php echo htmlspecialchars($link, ENT_QUOTES, 'UTF-8'); ?>">
+<?php endif; ?>
+    <?php echo HTMLHelper::_('image', $image->folder . '/' . htmlspecialchars($image->name, ENT_COMPAT, 'UTF-8'), '', ['width' => $image->width, 'height' => $image->height]); ?>
+<?php if ($link) : ?>
+</a>
+<?php endif; ?>
+</div>