badmanners/shimmie2
badmanners/shimmie2
Archived
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Custom rating support, user rating filter settings

Browse source
This commit is contained in:
Matthew Barbour 2019-06-26 23:11:59 -05:00 committed by matthew
parent 8f0aa8a4ca
commit 68ee4d0e77
11 changed files with 288 additions and 83 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
core/imageboard/image.php
View file

@ -299,6 +299,9 @@ class Image
["tag"=>$tags[0]]
);
} else {
if(ext_is_live("Ratings")) {
$tags[] = "rating:*";
}
list($tag_conditions, $img_conditions) = self::terms_to_conditions($tags);
$total = Image::get_accelerated_count($tag_conditions, $img_conditions);
if (is_null($total)) {

2
ext/comment/main.php
View file

@ -407,7 +407,7 @@ class CommentList extends Extension
LIMIT :limit OFFSET :offset
", ["limit"=>$threads_per_page, "offset"=>$start]);
$user_ratings = ext_is_live("Ratings") ? Ratings::get_user_privs($user) : "";
$user_ratings = ext_is_live("Ratings") ? Ratings::get_user_class_privs($user) : "";
$images = [];
while ($row = $result->fetch()) {

2
ext/danbooru_api/main.php
View file

@ -246,7 +246,7 @@ class DanbooruApi extends Extension
"preview_url" => $img->get_thumb_link(),
"preview_height" => $previewsize[1],
"preview_width" => $previewsize[0],
"rating" => "u",
"rating" => "?",
"date" => $img->posted,
"is_warehoused" => false,
"tags" => $taglist,

2
ext/featured/main.php
View file

@ -74,7 +74,7 @@ class Featured extends Extension
}
if (!is_null($image)) {
if (ext_is_live("Ratings")) {
if (strpos(Ratings::get_user_privs($user), $image->rating) === false) {
if (strpos(Ratings::get_user_class_privs($user), $image->rating) === false) {
return;
}
}

2
ext/pools/main.php
View file

@ -807,7 +807,7 @@ class Pools extends Extension
// WE CHECK IF THE EXTENSION RATING IS INSTALLED, WHICH VERSION AND IF IT
// WORKS TO SHOW/HIDE SAFE, QUESTIONABLE, EXPLICIT AND UNRATED IMAGES FROM USER
if (ext_is_live("Ratings")) {
$query .= "AND i.rating IN (".Ratings::privs_to_sql(Ratings::get_user_privs($user)).")";
$query .= "AND i.rating IN (".Ratings::privs_to_sql(Ratings::get_user_class_privs($user)).")";
}
if(ext_is_live("trash")) {
$query .= $database->scoreql_to_sql(" AND trash = SCORE_BOOL_N ");

262
ext/rating/main.php
View file

@ -48,31 +48,43 @@ class Rating {
public function __construct( string $code, string $name, string $search_term, int $order)
{
global $_shm_ratings;
if(strlen($code)!=1) {
throw new Exception("Rating code must be exactly one character");
}
if($search_term[0]!=$code) {
throw new Exception("Code must be the same as the first letter of search_term");
}
$this->name = $name;
$this->code = $code;
$this->search_term = $search_term;
$this->order = $order;
if($code=="u"&&array_key_exists("u",$_shm_ratings)) {
throw new Exception("u is a reserved rating code that cnanot be overridden");
}
$_shm_ratings[$code] = $this;
}
}
new Rating("s", "Safe", "safe", 0);
new Rating("q", "Questionable", "questionable", 500);
new Rating("e", "Explicit", "explicit", 1000);
new Rating("u", "Unrated", "unrated", 99999);
function clear_ratings() {
global $_shm_ratings;
$keys = array_keys($_shm_ratings);
foreach ($keys as $key){
if($key=="?") {
continue;
}
unset($_shm_ratings[$key]);
}
}
function add_rating(Rating $rating) {
global $_shm_ratings;
if($rating->code=="?"&&array_key_exists("?",$_shm_ratings)) {
throw new Exception("? is a reserved rating code that cannot be overridden");
}
$_shm_ratings[$rating->code] = $rating;
}
add_rating(new Rating("?", "Unrated", "unrated", 99999));
add_rating(new Rating("s", "Safe", "safe", 0));
add_rating(new Rating("q", "Questionable", "questionable", 500));
add_rating(new Rating("e", "Explicit", "explicit", 1000));
@include_once "data/config/ratings.conf.php";
class RatingSetEvent extends Event
@ -93,6 +105,11 @@ class RatingSetEvent extends Event
}
}
abstract class RatingsConfig {
const VERSION = "ext_ratings2_version";
const USER_DEFAULTS = "ratings_default";
}
class Ratings extends Extension
{
protected $db_support = [DatabaseDriver::MYSQL, DatabaseDriver::PGSQL];
@ -100,18 +117,19 @@ class Ratings extends Extension
private $search_regexp;
public function __construct() {
public function __construct()
{
parent::__construct();
global $_shm_ratings;
$codes = implode("",array_keys($_shm_ratings));
$codes = implode("", array_keys($_shm_ratings));
$search_terms = [];
foreach($_shm_ratings as $key=>$rating) {
foreach ($_shm_ratings as $key => $rating) {
array_push($search_terms, $rating->search_term);
}
$this->search_regexp = "/^rating[=|:](?:([".$codes."]+)|(".
implode("|", $search_terms)."|unknown))$/D";
$this->search_regexp = "/^rating[=|:](?:(\*|[" . $codes . "]+)|(" .
implode("|", $search_terms) . "|unknown))$/D";
}
public function get_priority(): int
@ -121,46 +139,59 @@ class Ratings extends Extension
public function onInitExt(InitExtEvent $event)
{
global $config, $_shm_user_classes, $_shm_ratings;
if ($config->get_int("ext_ratings2_version") < 4) {
global $user, $config, $user_config, $_shm_user_classes, $_shm_ratings;
if ($config->get_int(RatingsConfig::VERSION) < 4) {
$this->install();
}
foreach(array_keys($_shm_user_classes) as $key){
if($key=="base"||$key=="hellbanned") {
foreach (array_keys($_shm_user_classes) as $key) {
if ($key == "base" || $key == "hellbanned") {
continue;
}
$config->set_default_array("ext_rating_".$key."_privs", array_keys($_shm_ratings));
$config->set_default_array("ext_rating_" . $key . "_privs", array_keys($_shm_ratings));
}
$user_config->set_default_array(RatingsConfig::USER_DEFAULTS, self::get_user_class_privs($user));
}
public function onUserOptionsBuilding(UserOptionsBuildingEvent $event)
{
global $user, $user_config;
$event->add__html(
$this->theme->get_user_options($user,
self::get_user_default_ratings($user),
self::get_user_class_privs($user)));
}
public function onSetupBuilding(SetupBuildingEvent $event)
{
global $config, $_shm_user_classes, $_shm_ratings;
$ratings = array_values($_shm_ratings);
usort($ratings, function($a, $b) {
return $a->order <=> $b->order;
});
$ratings = self::get_sorted_ratings();
$options = [];
foreach($ratings as $key => $rating) {
$options[$rating->name] = $rating->code;
}
foreach ($ratings as $key => $rating) {
$options[$rating->name] = $rating->code;
}
$sb = new SetupBlock("Image Ratings");
foreach(array_keys($_shm_user_classes) as $key){
if($key=="base"||$key=="hellbanned") {
$sb->start_table();
foreach (array_keys($_shm_user_classes) as $key) {
if ($key == "base" || $key == "hellbanned") {
continue;
}
$sb->add_multichoice_option("ext_rating_".$key."_privs", $options, "<br/>".$key.": ");
$sb->add_multichoice_option("ext_rating_" . $key . "_privs", $options, $key, true);
}
$sb->end_table();
$event->panel->add_block($sb);
}
// public function onPostListBuilding(PostListBuildingEvent $event)
// {
// global $user;
@ -169,20 +200,20 @@ class Ratings extends Extension
// }
// }
public function onDisplayingImage(DisplayingImageEvent $event)
{
global $user, $page;
/**
* Deny images upon insufficient permissions.
**/
$user_view_level = Ratings::get_user_privs($user);
$user_view_level = Ratings::get_user_class_privs($user);
if (!in_array($event->image->rating, $user_view_level)) {
$page->set_mode(PageMode::REDIRECT);
$page->set_redirect(make_link("post/list"));
}
}
public function onRatingSet(RatingSetEvent $event)
{
if (empty($event->image->rating)) {
@ -192,12 +223,12 @@ class Ratings extends Extension
}
$this->set_rating($event->image->id, $event->rating, $old_rating);
}
public function onImageInfoBoxBuilding(ImageInfoBoxBuildingEvent $event)
{
$event->add_part($this->theme->get_rater_html($event->image->id, $event->image->rating, $this->can_rate()), 80);
}
public function onImageInfoSet(ImageInfoSetEvent $event)
{
if ($this->can_rate() && isset($_POST["rating"])) {
@ -231,10 +262,10 @@ class Ratings extends Extension
public function onSearchTermParse(SearchTermParseEvent $event)
{
global $user, $_shm_ratings;
$matches = [];
if (is_null($event->term) && $this->no_rating_query($event->context)) {
$set = Ratings::privs_to_sql(Ratings::get_user_privs($user));
$set = Ratings::privs_to_sql(Ratings::get_user_default_ratings($user));
$event->add_querylet(new Querylet("rating IN ($set)"));
}
@ -242,7 +273,11 @@ class Ratings extends Extension
if (preg_match($this->search_regexp, strtolower($event->term), $matches)) {
$ratings = $matches[1] ? $matches[1] : $matches[2][0];
$ratings = array_intersect(str_split($ratings), Ratings::get_user_privs($user));
if ($ratings == '*') {
$ratings = Ratings::get_user_class_privs($user);
} else {
$ratings = array_intersect(str_split($ratings), Ratings::get_user_class_privs($user));
}
$set = "'" . join("', '", $ratings) . "'";
$event->add_querylet(new Querylet("rating IN ($set)"));
@ -256,10 +291,11 @@ class Ratings extends Extension
if (preg_match($this->search_regexp, strtolower($event->term), $matches) && $event->parse) {
$ratings = $matches[1] ? $matches[1] : $matches[2][0];
$ratings = array_intersect(str_split($ratings), Ratings::get_user_privs($user));
$ratings = array_intersect(str_split($ratings), Ratings::get_user_class_privs($user));
$rating = $ratings[0];
$image = Image::by_id($event->id);
$re = new RatingSetEvent($image, $rating);
@ -271,13 +307,57 @@ class Ratings extends Extension
$event->metatag = true;
}
}
public function onAdminBuilding(AdminBuildingEvent $event)
{
global $database, $_shm_ratings;
$results = $database->get_col("SELECT DISTINCT rating FROM images ORDER BY rating");
$original_values = [];
foreach ($results as $result) {
if (array_key_exists($result, $_shm_ratings)) {
$original_values[$result] = $_shm_ratings[$result]->name;
} else {
$original_values[$result] = $result;
}
}
$this->theme->display_form($original_values, self::get_sorted_ratings());
}
public function onAdminAction(AdminActionEvent $event)
{
global $database, $user;
$action = $event->action;
switch ($action) {
case "update_ratings":
$event->redirect = true;
if(!array_key_exists("rating_old", $_POST) || empty($_POST["rating_old"])) {
return;
}
if(!array_key_exists("rating_new", $_POST) || empty($_POST["rating_new"])) {
return;
}
$old = $_POST["rating_old"];
$new = $_POST["rating_new"];
if($user->can("bulk_edit_image_rating")) {
$database->execute("UPDATE images SET rating = :new WHERE rating = :old", ["new"=>$new, "old"=>$old ]);
}
break;
}
}
public function onBulkActionBlockBuilding(BulkActionBlockBuildingEvent $event)
{
global $user;
if ($user->can(Permissions::BULK_EDIT_IMAGE_RATING)) {
$event->add_action("bulk_rate","Set Rating","",$this->theme->get_selection_rater_html("bulk_rating"));
$event->add_action("bulk_rate", "Set (R)ating", "r","", $this->theme->get_selection_rater_html(["?"]));
}
}
@ -287,11 +367,11 @@ class Ratings extends Extension
switch ($event->action) {
case "bulk_rate":
if (!isset($_POST['bulk_rating'])) {
if (!isset($_POST['rating'])) {
return;
}
if ($user->can(Permissions::BULK_EDIT_IMAGE_RATING)) {
$rating = $_POST['bulk_rating'];
$rating = $_POST['rating'];
$total = 0;
foreach ($event->items as $image) {
send_event(new RatingSetEvent($image, $rating));
@ -305,8 +385,8 @@ class Ratings extends Extension
public function onPageRequest(PageRequestEvent $event)
{
global $user, $page;
global $user, $page, $user_config;
if ($event->page_matches("admin/bulk_rate")) {
if (!$user->can(Permissions::BULK_EDIT_IMAGE_RATING)) {
throw new PermissionDeniedException();
@ -317,9 +397,9 @@ class Ratings extends Extension
if (count($images) == 0) {
break;
}
reset($images); // rewind to first element in array.
foreach ($images as $image) {
send_event(new RatingSetEvent($image, $_POST['rating']));
}
@ -334,15 +414,65 @@ class Ratings extends Extension
$page->set_redirect(make_link("post/list"));
}
}
if ($event->page_matches("user_admin")) {
if (!$user->check_auth_token()) {
return;
}
switch ($event->get_arg(0)) {
case "default_ratings":
if (!array_key_exists("id", $_POST) || empty($_POST["id"])) {
return;
}
if (!array_key_exists("rating", $_POST) || empty($_POST["rating"])) {
return;
}
$id = intval($_POST["id"]);
if ($id != $user->id) {
throw new SCoreException("Cannot change another user's settings");
}
$ratings = $_POST["rating"];
$user_config->set_array(RatingsConfig::USER_DEFAULTS, $ratings);
$page->set_mode(PageMode::REDIRECT);
$page->set_redirect(make_link("user"));
break;
}
}
}
public static function get_user_privs(User $user): array
public static function get_sorted_ratings(): array
{
global $_shm_ratings;
$ratings = array_values($_shm_ratings);
usort($ratings, function ($a, $b) {
return $a->order <=> $b->order;
});
return $ratings;
}
public static function get_user_class_privs(User $user): array
{
global $config;
return $config->get_array("ext_rating_".$user->class->name."_privs");
}
public static function get_user_default_ratings(User $user): array
{
global $user_config;
$available = self::get_user_class_privs($user);
$selected = $user_config->get_array(RatingsConfig::USER_DEFAULTS);
return array_intersect($available, $selected);
}
public static function privs_to_sql(array $privs): string
{
$arr = [];
@ -402,18 +532,18 @@ class Ratings extends Extension
{
global $database, $config;
if ($config->get_int("ext_ratings2_version") < 1) {
if ($config->get_int(RatingsConfig::VERSION) < 1) {
$database->Execute("ALTER TABLE images ADD COLUMN rating CHAR(1) NOT NULL DEFAULT 'u'");
$database->Execute("CREATE INDEX images__rating ON images(rating)");
$config->set_int("ext_ratings2_version", 3);
$config->set_int(RatingsConfig::VERSION, 3);
}
if ($config->get_int("ext_ratings2_version") < 2) {
if ($config->get_int(RatingsConfig::VERSION) < 2) {
$database->Execute("CREATE INDEX images__rating ON images(rating)");
$config->set_int("ext_ratings2_version", 2);
$config->set_int(RatingsConfig::VERSION, 2);
}
if($config->get_int("ext_ratings2_version") < 3) {
if($config->get_int(RatingsConfig::VERSION) < 3) {
$database->Execute("UPDATE images SET rating = 'u' WHERE rating is null");
switch ($database->get_driver_name()) {
case DatabaseDriver::MYSQL:
@ -424,17 +554,23 @@ class Ratings extends Extension
$database->Execute("ALTER TABLE images ALTER COLUMN rating SET NOT NULL");
break;
}
$config->set_int("ext_ratings2_version", 3);
$config->set_int(RatingsConfig::VERSION, 3);
}
if ($config->get_int("ext_ratings2_version") < 4) {
if ($config->get_int(RatingsConfig::VERSION) < 4) {
$value = $config->get_string("ext_rating_anon_privs");
$config->set_array("ext_rating_anonymous_privs", str_split($value));
$value = $config->get_string("ext_rating_user_privs");
$config->set_array("ext_rating_user_privs", str_split($value));
$value = $config->get_string("ext_rating_admin_privs");
$config->set_array("ext_rating_admin_privs", str_split($value));
$config->set_int("ext_ratings2_version", 4);
$config->set_int(RatingsConfig::VERSION, 4);
}
if ($config->get_int(RatingsConfig::VERSION) < 5) {
$config->set_int(RatingsConfig::VERSION, 5);
}
}

69
ext/rating/theme.php
View file

@ -12,7 +12,7 @@ class RatingsTheme extends Themelet
".($can_rate ? "
<span class='view'>$human_rating</span>
<span class='edit'>
".$this->get_selection_rater_html($rating)."
".$this->get_selection_rater_html([$rating])."
</span>
" : "
$human_rating
@ -23,6 +23,29 @@ class RatingsTheme extends Themelet
return $html;
}
public function display_form(array $current_ratings, array $available_ratings)
{
global $page, $database;
$html = make_form(make_link("admin/update_ratings"))."<table class='form'><tr>
<th>Change</th><td><select name='rating_old' required='required'><option></option>";
foreach ($current_ratings as $key=>$value) {
$html .= "<option value='$key'>$value</option>";
}
$html .= "</select></td></tr>
<tr><th>To</th><td><select name='rating_new' required='required'><option></option>";
foreach ($available_ratings as $value) {
$html .= "<option value='$value->code'>$value->name</option>";
}
$html .= "</select></td></tr>
<tr><td colspan='2'><input type='submit' value='Update'></td></tr></table>
</form>\n";
$page->add_block(new Block("Update Ratings", $html));
}
// public function display_bulk_rater(string $terms)
// {
// global $page;
@ -41,17 +64,21 @@ class RatingsTheme extends Themelet
// $page->add_block(new Block("List Controls", $html, "left"));
// }
public function get_selection_rater_html(String $selected_option, String $id = "rating") {
public function get_selection_rater_html(array $selected_options, bool $multiple = false, array $available_options = null) {
global $_shm_ratings;
$output = "<select name='".$id."'>";
$options = array_values($_shm_ratings);
usort($options, function($a, $b) {
return $a->order <=> $b->order;
});
foreach($options as $option) {
$output .= "<option value='".$option->code."' ".($selected_option==$option->code ? "selected='selected'": "").">".$option->name."</option>";
$output = "<select name='rating".($multiple ? "[]' multiple='multiple'" : "' ")." >";
$options = Ratings::get_sorted_ratings();
foreach($options as $option) {
if($available_options!=null && !in_array($option->code, $available_options)) {
continue;
}
$output .= "<option value='".$option->code."' ".
(in_array($option->code,$selected_options) ? "selected='selected'": "")
.">".$option->name."</option>";
}
return $output."</select>";
}
@ -82,5 +109,27 @@ class RatingsTheme extends Themelet
}
$output .= "</table>";
return $output;
public function get_user_options(User $user, array $selected_ratings, array $available_ratings): string
{
$html = "
<p>".make_form(make_link("user_admin/default_ratings"))."
<input type='hidden' name='id' value='$user->id'>
<table style='width: 300px;'>
<thead>
<tr><th colspan='2'>Default Rating Filter</th></tr>
</thead>
<tbody>
<tr><td>This controls the default rating search results will be filtered by, and nothing else. To override in your search results, add rating:* to your search.</td></tr>
<tr><td>
".$this->get_selection_rater_html($selected_ratings, true, $available_ratings)."
</td></tr>
</tbody>
<tfoot>
<tr><td><input type='submit' value='Save'></td></tr>
</tfoot>
</table>
</form>
";
return $html;
}
}

17
ext/upgrade/main.php
View file

@ -243,6 +243,23 @@ class Upgrade extends Extension
$config->set_bool("in_upgrade", false);
}
if ($config->get_int("db_version") < 19) {
$config->set_bool("in_upgrade", true);
$config->set_int("db_version", 19);
log_info("upgrade", "Updating to new unrated code");
if ($database->get_driver_name()==DatabaseDriver::PGSQL) { // These updates can take a little bit
$database->execute("SET statement_timeout TO 300000;");
}
$database->execute("UPDATE images SET rating = :new WHERE rating = :old", ["new"=>'?', "old"=>'u' ]);
log_info("upgrade", "Database at version 19");
$config->set_bool("in_upgrade", false);
}
}
public function get_priority(): int

4
themes/danbooru/view.theme.php
View file

@ -47,8 +47,8 @@ class CustomViewImageTheme extends ViewImageTheme
}
if (ext_is_live("Ratings")) {
if ($image->rating == null || $image->rating == "u") {
$image->rating = "u";
if ($image->rating == null || $image->rating == "?") {
$image->rating = "?";
}
$h_rating = Ratings::rating_to_human($image->rating);
$html .= "<br>Rating: $h_rating";

4
themes/danbooru2/view.theme.php
View file

@ -48,8 +48,8 @@ class CustomViewImageTheme extends ViewImageTheme
}
if (ext_is_live("Ratings")) {
if ($image->rating == null || $image->rating == "u") {
$image->rating = "u";
if ($image->rating == null || $image->rating == "?") {
$image->rating = "?";
}
if (ext_is_live("Ratings")) {
$h_rating = Ratings::rating_to_human($image->rating);

4
themes/lite/view.theme.php
View file

@ -48,8 +48,8 @@ class CustomViewImageTheme extends ViewImageTheme
}
if (ext_is_live("Ratings")) {
if ($image->rating == null || $image->rating == "u") {
$image->rating = "u";
if ($image->rating == null || $image->rating == "?") {
$image->rating = "?";
}
$h_rating = Ratings::rating_to_human($image->rating);
$html .= "<br>Rating: $h_rating";