Merge pull request 'refactor IP notes backend' (#106) from ip-note-queries into config

Reviewed-on: leftypol/leftypol#106

inc/Data/IpNoteQueries.php

@@ -0,0 +1,76 @@
+<?php
+namespace Vichan\Data;
+
+use Vichan\Data\Driver\CacheDriver;
+
+
+class IpNoteQueries {
+	private \PDO $pdo;
+	private CacheDriver $cache;
+
+
+	public function __construct(\PDO $pdo, CacheDriver $cache) {
+		$this->pdo = $pdo;
+		$this->cache = $cache;
+	}
+
+	/**
+	 * Get all the notes relative to an IP.
+	 *
+	 * @param string $ip The IP of the notes. THE STRING IS NOT VALIDATED.
+	 * @return array Returns an array of notes sorted by the most recent. Includes the username of the mods.
+	 */
+	public function getByIp(string $ip) {
+		$ret = $this->cache->get("ip_note_queries_$ip");
+		if ($ret !== null) {
+			return $ret;
+		}
+
+		$query = $this->pdo->prepare('SELECT `ip_notes`.*, `username` FROM `ip_notes` LEFT JOIN `mods` ON `mod` = `mods`.`id` WHERE `ip` = :ip ORDER BY `time` DESC');
+		$query->bindValue(':ip', $ip);
+		$query->execute();
+		$ret = $query->fetchAll(\PDO::FETCH_ASSOC);
+
+		$this->cache->set("ip_note_queries_$ip", $ret);
+		return $ret;
+	}
+
+	/**
+	 * Creates a new note relative to the given ip.
+	 *
+	 * @param string $ip The IP of the note. THE STRING IS NOT VALIDATED.
+	 * @param int $mod_id The id of the mod who created the note.
+	 * @param string $body The text of the note.
+	 * @return void
+	 */
+	public function add(string $ip, int $mod_id, string $body) {
+		$query = $this->pdo->prepare('INSERT INTO `ip_notes` (`ip`, `mod`, `time`, `body`) VALUES (:ip, :mod, :time, :body)');
+		$query->bindValue(':ip', $ip);
+		$query->bindValue(':mod', $mod_id);
+		$query->bindValue(':time', time());
+		$query->bindValue(':body', $body);
+		$query->execute();
+
+		$this->cache->delete("ip_note_queries_$ip");
+	}
+
+	/**
+	 * Delete a note only if it's of a particular IP address.
+	 *
+	 * @param int $id The id of the note.
+	 * @param int $ip The expected IP of the note. THE STRING IS NOT VALIDATED.
+	 * @return bool True if any note was deleted.
+	 */
+	public function deleteWhereIp(int $id, string $ip): bool {
+		$query = $this->pdo->prepare('DELETE FROM `ip_notes` WHERE `ip` = :ip AND `id` = :id');
+		$query->bindValue(':ip', $ip);
+		$query->bindValue(':id', $id);
+		$query->execute();
+		$any = $query->rowCount() != 0;
+
+		if ($any) {
+			$this->cache->delete("ip_note_queries_$ip");
+		}
+		return $any;
+	}
+}

inc/context.php

@@ -2,7 +2,7 @@
 namespace Vichan;
 
 use Vichan\Data\Driver\CacheDriver;
-use Vichan\Data\{ReportQueries, UserPostQueries};
+use Vichan\Data\{IpNoteQueries, ReportQueries, UserPostQueries};
 
 defined('TINYBOARD') or exit;
 
@@ -48,6 +48,7 @@ function build_context(array $config): Context {
 		},
 		UserPostQueries::class => function($c) {
 			return new UserPostQueries($c->get(\PDO::class));
-		}
+		},
+		IpNoteQueries::class => fn($c) => new IpNoteQueries($c->get(\PDO::class), $c->get(CacheDriver::class)),
 	]);
 }

inc/mod/pages.php

@@ -3,7 +3,7 @@
  *  Copyright (c) 2010-2013 Tinyboard Development Group
  */
 use Vichan\Context;
-use Vichan\Data\{UserPostQueries, ReportQueries};
+use Vichan\Data\{IpNoteQueries, UserPostQueries, ReportQueries};
 use Vichan\Functions\Net;
 
 defined('TINYBOARD') or exit;
@@ -851,18 +851,26 @@ function mod_view_thread50(Context $ctx, $boardName, $thread) {
 }
 
 function mod_ip_remove_note(Context $ctx, $ip, $id) {
-    global $config;
+    $config = $ctx->get('config');
 
-    if (!hasPermission($config['mod']['remove_notes']))
+    if (!hasPermission($config['mod']['remove_notes'])) {
         error($config['error']['noaccess']);
+    }
 
-    if (filter_var($ip, FILTER_VALIDATE_IP) === false)
+    if (filter_var($ip, \FILTER_VALIDATE_IP) === false) {
         error('Invalid IP address');
+    }
 
-    $query = prepare('DELETE FROM ``ip_notes`` WHERE `ip` = :ip AND `id` = :id');
+    if (!is_numeric($id)) {
-    $query->bindValue(':ip', $ip);
+        error('Invalid note ID');
-    $query->bindValue(':id', $id);
+    }
-    $query->execute() or error(db_error($query));
+
+    $queries = $ctx->get(IpNoteQueries::class);
+    $deleted = $queries->deleteWhereIp((int)$id, $ip);
+
+    if (!$deleted) {
+        error("Note $id does not exist for $ip");
+    }
 
     modLog("Removed a note for <a href=\"?/user_posts/ip/{$ip}\">{$ip}</a>");
 
@@ -870,14 +878,17 @@ function mod_ip_remove_note(Context $ctx, $ip, $id) {
 }
 
 function mod_ip(Context $ctx, $ip, string $encoded_cursor = null) {
-    global $config, $mod;
+    global $mod;
+    $config = $ctx->get('config');
 
-    if (filter_var($ip, FILTER_VALIDATE_IP) === false)
+    if (filter_var($ip, FILTER_VALIDATE_IP) === false) {
         error('Invalid IP address');
+    }
 
     if (isset($_POST['ban_id'], $_POST['unban'])) {
-        if (!hasPermission($config['mod']['unban']))
+        if (!hasPermission($config['mod']['unban'])) {
             error($config['error']['noaccess']);
+        }
 
         Bans::delete($_POST['ban_id'], true, $mod['boards']);
 
@@ -890,17 +901,15 @@ function mod_ip(Context $ctx, $ip, string $encoded_cursor = null) {
     }
 
     if (isset($_POST['note'])) {
-        if (!hasPermission($config['mod']['create_notes']))
+        if (!hasPermission($config['mod']['create_notes'])) {
             error($config['error']['noaccess']);
+        }
 
         $_POST['note'] = escape_markup_modifiers($_POST['note']);
         markup($_POST['note']);
-        $query = prepare('INSERT INTO ``ip_notes`` VALUES (NULL, :ip, :mod, :time, :body)');
+
-        $query->bindValue(':ip', $ip);
+        $note_queries = $ctx->get(IpNoteQueries::class);
-        $query->bindValue(':mod', $mod['id']);
+        $note_queries->add($ip, $mod['id'], $_POST['note']);
-        $query->bindValue(':time', time());
-        $query->bindValue(':body', $_POST['note']);
-        $query->execute() or error(db_error($query));
 
         Cache::delete("mod_page_ip_view_notes_$ip");
 
@@ -952,15 +961,8 @@ function mod_user_posts_by_ip(Context $ctx, string $ip, string $encoded_cursor =
     }
 
     if (hasPermission($config['mod']['view_notes'])) {
-        $ret = Cache::get("mod_page_ip_view_notes_$ip");
+        $note_queries = $ctx->get(IpNoteQueries::class);
-        if (!$ret) {
+        $args['notes'] = $note_queries->getByIp($ip);
-            $query = prepare("SELECT ``ip_notes``.*, `username` FROM ``ip_notes`` LEFT JOIN ``mods`` ON `mod` = ``mods``.`id` WHERE `ip` = :ip ORDER BY `time` DESC");
-            $query->bindValue(':ip', $ip);
-            $query->execute() or error(db_error($query));
-            $ret = $query->fetchAll(PDO::FETCH_ASSOC);
-            Cache::set("mod_page_ip_view_notes_$ip", $ret, 900);
-        }
-        $args['notes'] = $ret;
     }
 
     if (hasPermission($config['mod']['modlog_ip'])) {
@@ -1998,13 +2000,9 @@ function mod_ban_post(Context $ctx, $board, $delete, $post, $token = false) {
                     $autotag .= "/${board}/" . " " . $filehash .  " " . $filename ."\r\n";
                     $autotag .= $body . "\r\n";
                     $autotag = escape_markup_modifiers($autotag);
-                    markup($autotag);
+
-                    $query = prepare('INSERT INTO ``ip_notes`` VALUES (NULL, :ip, :mod, :time, :body)');
+                    $note_queries = $ctx->get(IpNoteQueries::class);
-                    $query->bindValue(':ip', $ip);
+                    $note_queries->add($ip, $mod['id'], $autotag);
-                    $query->bindValue(':mod', $mod['id']);
-                    $query->bindValue(':time', time());
-                    $query->bindValue(':body', $autotag);
-                    $query->execute() or error(db_error($query));
                     modLog("Added a note for <a href=\"?/user_posts/ip/{$ip}\">{$ip}</a>");
                 }
             }
@@ -2110,12 +2108,9 @@ function mod_warning_post(Context $ctx, $board, $post, $token = false) {
                     $autotag .= $body . "\r\n";
                     $autotag = escape_markup_modifiers($autotag);
                     markup($autotag);
-                    $query = prepare('INSERT INTO ``ip_notes`` VALUES (NULL, :ip, :mod, :time, :body)');
+
-                    $query->bindValue(':ip', $ip);
+                    $note_queries = $ctx->get(IpNoteQueries::class);
-                    $query->bindValue(':mod', $mod['id']);
+                    $note_queries->add($ip, $mod['id'], $autotag);
-                    $query->bindValue(':time', time());
-                    $query->bindValue(':body', $autotag);
-                    $query->execute() or error(db_error($query));
                     modLog("Added a note for <a href=\"?/user_posts/ip/{$ip}\">{$ip}</a>");
                 }
             }
@@ -2221,7 +2216,7 @@ function mod_edit_post(Context $ctx, $board, $edit_raw_html, $postID) {
 }
 
 function mod_delete(Context $ctx, $board, $post) {
-	global $config;
+	global $config, $mod;
 
     if (!openBoard($board))
         error($config['error']['noboard']);
@@ -2262,12 +2257,9 @@ function mod_delete(Context $ctx, $board, $post) {
             $autotag .= $body . "\r\n";
             $autotag = escape_markup_modifiers($autotag);
             markup($autotag);
-            $query = prepare('INSERT INTO ``ip_notes`` VALUES (NULL, :ip, :mod, :time, :body)');
+
-            $query->bindValue(':ip', $ip);
+            $note_queries = $ctx->get(IpNoteQueries::class);
-            $query->bindValue(':mod', $mod['id']);
+            $note_queries->add($ip, $mod['id'], $autotag);
-            $query->bindValue(':time', time());
-            $query->bindValue(':body', $autotag);
-            $query->execute() or error(db_error($query));
             modLog("Added a note for <a href=\"?/user_posts/ip/{$ip}\">{$ip}</a>");
         }
     }
@@ -2355,7 +2347,7 @@ function mod_spoiler_image(Context $ctx, $board, $post, $file) {
 }
 
 function mod_deletebyip(Context $ctx, $boardName, $post, $global = false) {
-	global $config, $board;
+	global $config, $board, $mod;
 
     $global = (bool)$global;
 
@@ -2433,12 +2425,9 @@ function mod_deletebyip(Context $ctx, $boardName, $post, $global = false) {
                 $autotag .= $body . "\r\n";
                 $autotag = escape_markup_modifiers($autotag);
                 markup($autotag);
-                $query2 = prepare('INSERT INTO ``ip_notes`` VALUES (NULL, :ip, :mod, :time, :body)');
+
-                $query2->bindValue(':ip', $ip);
+                $note_queries = $ctx->get(IpNoteQueries::class);
-                $query2->bindValue(':mod', $mod['id']);
+                $note_queries->add($ip, $mod['id'], $autotag);
-                $query2->bindValue(':time', time());
-                $query2->bindValue(':body', $autotag);
-                $query2->execute() or error(db_error($query2));
                 modLog("Added a note for <a href=\"?/user_posts/ip/{$ip}\">{$ip}</a>");
             }
         }