BookStack Code Mirror - bookstack/blob - app/Console/Commands/AssignSortRuleCommand.php

   1 <?php
   2
   3 namespace BookStack\Console\Commands;
   4
   5 use BookStack\Entities\Models\Book;
   6 use BookStack\Sorting\BookSorter;
   7 use BookStack\Sorting\SortRule;
   8 use Illuminate\Console\Command;
   9
  10 class AssignSortRuleCommand extends Command
  11 {
  12     /**
  13      * The name and signature of the console command.
  14      *
  15      * @var string
  16      */
  17     protected $signature = 'bookstack:assign-sort-rule
  18                             {sort-rule=0: ID of the sort rule to apply}
  19                             {--all-books : Apply to all books in the system}
  20                             {--books-without-sort : Apply to only books without a sort rule already assigned}
  21                             {--books-with-sort= : Apply to only books with the sort rule of given id}';
  22
  23     /**
  24      * The console command description.
  25      *
  26      * @var string
  27      */
  28     protected $description = 'Assign a sort rule to content in the system';
  29
  30     /**
  31      * Execute the console command.
  32      */
  33     public function handle(BookSorter $sorter): int
  34     {
  35         $sortRuleId = intval($this->argument('sort-rule')) ?? 0;
  36         if ($sortRuleId === 0) {
  37             return $this->listSortRules();
  38         }
  39
  40         $rule = SortRule::query()->find($sortRuleId);
  41         if ($this->option('all-books')) {
  42             $query = Book::query();
  43         } else if ($this->option('books-without-sort')) {
  44             $query = Book::query()->whereNull('sort_rule_id');
  45         } else if ($this->option('books-with-sort')) {
  46             $sortId = intval($this->option('books-with-sort')) ?: 0;
  47             if (!$sortId) {
  48                 $this->error("Provided --books-with-sort option value is invalid");
  49                 return 1;
  50             }
  51             $query = Book::query()->where('sort_rule_id', $sortId);
  52         } else {
  53             $this->error("No option provided to specify target. Run with the -h option to see all available options.");
  54             return 1;
  55         }
  56
  57         if (!$rule) {
  58             $this->error("Sort rule of provided id {$sortRuleId} not found!");
  59             return 1;
  60         }
  61
  62         $count = $query->clone()->count();
  63         $this->warn("This will apply sort rule [{$rule->id}: {$rule->name}] to {$count} book(s) and run the sort on each.");
  64         $confirmed = $this->confirm("Are you sure you want to continue?");
  65
  66         if (!$confirmed) {
  67             return 1;
  68         }
  69
  70         $processed = 0;
  71         $query->chunkById(10, function ($books) use ($rule, $sorter, $count, &$processed) {
  72             $max = min($count, ($processed + 10));
  73             $this->info("Applying to {$processed}-{$max} of {$count} books");
  74             foreach ($books as $book) {
  75                 $book->sort_rule_id = $rule->id;
  76                 $book->save();
  77                 $sorter->runBookAutoSort($book);
  78             }
  79             $processed = $max;
  80         });
  81
  82         $this->info("Sort applied to {$processed} book(s)!");
  83
  84         return 0;
  85     }
  86
  87     protected function listSortRules(): int
  88     {
  89
  90         $rules = SortRule::query()->orderBy('id', 'asc')->get();
  91         $this->error("Sort rule ID required!");
  92         $this->warn("\nAvailable sort rules:");
  93         foreach ($rules as $rule) {
  94             $this->info("{$rule->id}: {$rule->name}");
  95         }
  96
  97         return 1;
  98     }
  99 }