Reactions revamp & profile widgets

core/classes/DTO/Reaction.php

@@ -0,0 +1,77 @@
+<?php
+/**
+ * Represents a reaction.
+ *
+ * @package NamelessMC\DTO
+ * @author Aberdeener
+ * @version 2.1.0
+ * @license MIT
+ */
+class Reaction {
+
+    public const TYPE_POSITIVE = 2;
+    public const TYPE_NEGATIVE = 0;
+    public const TYPE_NEUTRAL = 1;
+    public const TYPE_CUSTOM = 3;
+
+    public const CONTEXTS = [
+        'forum_post',
+        'profile_post',
+        // Allow modules to register custom contexts?
+    ];
+
+    public int $id;
+    public string $name;
+    public string $html;
+    public string $raw_html;
+    public bool $enabled;
+    public int $type;
+    public int $order;
+    public ?int $custom_score;
+
+    public function __construct(object $row) {
+        $this->id = $row->id;
+        $this->name = $row->name;
+        $this->html = Text::renderEmojis($row->html);
+        $this->raw_html = $row->html;
+        $this->enabled = $row->enabled;
+        $this->type = $row->type;
+        $this->custom_score = $row->custom_score;
+        $this->order = $row->order;
+    }
+
+    /**
+     * @return array<int, Reaction>
+     */
+    public static function all(): array {
+        $rows = DB::getInstance()->query('SELECT * FROM nl2_reactions ORDER BY `order`')->results();
+        $fields = [];
+        foreach ($rows as $row) {
+            $fields[$row->id] = new Reaction($row);
+        }
+        return $fields;
+    }
+
+    /**
+     * @param string $value
+     * @param string $column
+     * @return array<int, Reaction>|Reaction
+     */
+    public static function find(string $value, string $column = 'id') {
+        $rows = DB::getInstance()->query("SELECT * FROM nl2_reactions WHERE `$column` = $value ORDER BY `order`");
+        if (!$rows->count()) {
+            return [];
+        }
+
+        if ($rows->count() === 1) {
+            return new Reaction($rows->first());
+        }
+
+        $fields = [];
+        foreach ($rows->results() as $row) {
+            $fields[$row->id] = new Reaction($row);
+        }
+
+        return $fields;
+    }
+}

core/classes/DTO/UserData.php

@@ -21,7 +21,6 @@ class UserData {
     public bool $active;
     public ?string $signature;
     public int $profile_views;
-    public int $reputation;
     public ?string $reset_code;
     public bool $has_avatar;
     public bool $gravatar;
@@ -56,7 +55,6 @@ public function __construct(object $row) {
         $this->active = $row->active;
         $this->signature = $row->signature;
         $this->profile_views = $row->profile_views;
-        $this->reputation = $row->reputation;
         $this->reset_code = $row->reset_code;
         $this->has_avatar = $row->has_avatar;
         $this->gravatar = $row->gravatar;

core/classes/Database/DB.php

@@ -206,21 +206,29 @@ public function error(): bool {
      * Perform a SELECT query on the database.
      *
      * @param string $table The table to select from.
-     * @param array $where The where clause.
+     * @param mixed $where The where clause. If not an array, it will be used for "id" column lookup.
      * @return static|false This instance if successful, false otherwise.
      */
-    public function get(string $table, array $where = []) {
+    public function get(string $table, $where = []) {
+        if (!is_array($where)) {
+            $where = ['id', '=', $where];
+        }
+
         return $this->action('SELECT *', $table, $where);
     }
 
     /**
      * Perform a DELETE query on the database.
      *
      * @param string $table The table to delete from.
-     * @param array $where The where clause.
+     * @param mixed $where The where clause. If not an array, it will be used for "id" column lookup.
      * @return static|false This instance if successful, false otherwise.
      */
-    public function delete(string $table, array $where) {
+    public function delete(string $table, $where) {
+        if (!is_array($where)) {
+            $where = ['id', '=', $where];
+        }
+
         return $this->action('DELETE', $table, $where);
     }
 

core/classes/Database/DatabaseInitialiser.php

@@ -155,23 +155,45 @@ private function initialiseIntegrations(): void {
     private function initialiseReactions(): void {
         $this->_db->insert('reactions', [
             'name' => 'Like',
-            'html' => '<i class="fas fa-thumbs-up text-success"></i>',
+            'html' => '👍',
             'enabled' => true,
-            'type' => 2
+            'type' => Reaction::TYPE_POSITIVE,
         ]);
 
         $this->_db->insert('reactions', [
             'name' => 'Dislike',
-            'html' => '<i class="fas fa-thumbs-down text-danger"></i>',
+            'html' => '👎',
             'enabled' => true,
-            'type' => 0
+            'type' => Reaction::TYPE_NEGATIVE,
         ]);
 
         $this->_db->insert('reactions', [
             'name' => 'Meh',
-            'html' => '<i class="fas fa-meh text-warning"></i>',
+            'html' => '😐',
             'enabled' => true,
-            'type' => 1
+            'type' => Reaction::TYPE_NEUTRAL,
+        ]);
+
+        $this->_db->insert('reactions', [
+            'name' => 'Helpful',
+            'html' => '🛠️',
+            'enabled' => true,
+            'type' => Reaction::TYPE_POSITIVE,
+        ]);
+
+        $this->_db->insert('reactions', [
+            'name' => 'Creative',
+            'html' => '🌈',
+            'enabled' => true,
+            'type' => Reaction::TYPE_POSITIVE,
+        ]);
+
+        $this->_db->insert('reactions', [
+            'name' => 'Amazing',
+            'html' => '⭐',
+            'enabled' => true,
+            'type' => Reaction::TYPE_CUSTOM,
+            'custom_score' => 5,
         ]);
     }
 

core/classes/Widgets/AbstractWidget.php

@@ -0,0 +1,159 @@
+<?php
+
+abstract class AbstractWidget {
+
+    protected string $_name;
+    protected string $_content;
+    protected string $_description;
+    protected string $_module;
+    protected ?string $_settings = null;
+    protected bool $_requires_cookies = false;
+    protected Smarty $_smarty;
+    protected WidgetData $_data;
+
+    /**
+     * Get the name of this widget.
+     *
+     * @return string Name of widget.
+     */
+    public function getName(): string {
+        return $this->_name;
+    }
+
+    /**
+     * Get the location (`left` or `right`) that this widget will be displayed on.
+     *
+     * @return string Location of widget.
+     */
+    public function getLocation(): string {
+        return $this->getData()->location;
+    }
+
+    /**
+     * Get the path to the file for settings of this widget.
+     *
+     * @return string Widget settings URL.
+     */
+    public function getSettings(): ?string {
+        return $this->_settings;
+    }
+
+    /**
+     * Get the description of this widget.
+     *
+     * @return string Description of widget.
+     */
+    public function getDescription(): string {
+        return $this->_description;
+    }
+
+    /**
+     * Get the module of this widget.
+     *
+     * @return string Name of module.
+     */
+    public function getModule(): string {
+        return $this->_module;
+    }
+
+    /**
+     * Get the display order of this widget.
+     *
+     * @return int Display order of widget.
+     */
+    public function getOrder(): int {
+        return $this->getData()->order;
+    }
+
+    /**
+     * Get Smarty instance in use by this widget.
+     *
+     * @return Smarty Instance in use.
+     */
+    public function getSmarty(): ?Smarty {
+        return $this->_smarty;
+    }
+
+    /**
+     * Render this widget to be displayed on a template page. If this widget requires cookies and cookies are not allowed, a cookie notice is displayed instead.
+     * Returns an empty string if this widget is not to be displayed.
+     *
+     * @throws Exception
+     * @throws SmartyException
+     *
+     * @return string Content/HTML of this widget.
+     */
+    public function display(): string {
+        if (defined('COOKIE_CHECK') && !COOKIES_ALLOWED && $this->_requires_cookies) {
+            return $this->_smarty->fetch('widgets/cookie_notice.tpl');
+        }
+
+        return $this->_content;
+    }
+
+    /**
+     * Get pages this widget is enabled on.
+     *
+     * @return array Pages this widget is enabled on.
+     */
+    abstract public function getPages(): array;
+
+    /**
+     * Clear the cache for this widget, should be called when any settings of it are changed.
+     */
+    final public function clearCache(): void {
+        $cache = new Cache();
+        $cache->setCache(
+            $this instanceof ProfileWidgetBase
+                ? 'profile_widgets'
+                : 'widgets'
+        );
+
+        $cache->erase($this->getName());
+    }
+
+    /**
+     * Get widget data.
+     * Will use cache if available, otherwise will query the database and store the result in cache.
+     *
+     * @return WidgetData Widget data.
+     */
+    protected function getData(): WidgetData {
+        if (isset($this->_data)) {
+            return $this->_data;
+        }
+
+        $cache = new Cache();
+        $cache->setCache(
+            $this instanceof ProfileWidgetBase
+                ? 'profile_widgets'
+                : 'widgets'
+        );
+
+        if ($cache->isCached($this->getName())) {
+            return $this->_data = new WidgetData($cache->retrieve($this->getName()));
+        }
+
+        $row = DB::getInstance()->get('widgets', ['name', $this->getName()]);
+        if ($row->count()) {
+            $data = new WidgetData($row->first());
+            $cache->store($this->getName(), $data);
+
+            return $this->_data = $data;
+        }
+
+        // Widget not found in database, create it
+        DB::getInstance()->insert('widgets', $data = [
+            'name' => $this->getName(),
+            'enabled' => true,
+            'location' => 'right',
+            'order' => 10,
+            'pages' => '["index","forum"]',
+        ]);
+
+        $data = new WidgetData((object) $data);
+        $cache->store($this->getName(), $data);
+
+        return $this->_data = $data;
+    }
+}

core/classes/Widgets/ProfileWidgetBase.php

@@ -0,0 +1,10 @@
+<?php
+
+abstract class ProfileWidgetBase extends AbstractWidget {
+
+    abstract public function initialise(User $user): void;
+
+    final public function getPages(): array {
+        return ['profile'];
+    }
+}