freescout-cleanup-module/Console/CleanupConversations.php

<?php

namespace Modules\Cleanup\Console;

use App\Conversation;
use Illuminate\Console\Command;
use Symfony\Component\Console\Input\InputOption;

class CleanupConversations extends Command {
    /**
     * The console command name.
     *
     * @var string
     */
    protected $name = 'cleanup:conversations';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Cleans up conversations based on supplied arguments.';

    /**
     * Create a new command instance.
     *
     * @return void
     */
    public function __construct() {
        parent::__construct();
    }

    /**
     * Get the console command options.
     *
     * @return array
     */
    protected function getOptions() {
        return [
            [ 'mailbox-id', null, InputOption::VALUE_OPTIONAL | InputOption::VALUE_IS_ARRAY, 'The IDs of the mailboxes to clean up conversations for (comma-separated).' ],
            [ 'status', null, InputOption::VALUE_OPTIONAL | InputOption::VALUE_IS_ARRAY, 'The statuses of conversations to clean up (1=active, 2=pending, 3=closed, 4=spam, comma-separated).' ],
            [ 'older-than-days', null, InputOption::VALUE_OPTIONAL, 'Clean up conversations older than the specified number of days.' ],
            [ 'subject-starts-with', null, InputOption::VALUE_OPTIONAL, 'Clean up conversations with subjects starting with the specified string.' ],
            [ 'subject-contains', null, InputOption::VALUE_OPTIONAL, 'Clean up conversations with subjects containing the specified string.' ],
            [ 'subject-ends-with', null, InputOption::VALUE_OPTIONAL, 'Clean up conversations with subjects ending with the specified string.' ],
            [ 'limit', null, InputOption::VALUE_OPTIONAL, 'Limit the number of conversations to delete.' ],
            [ 'dry-run', null, InputOption::VALUE_NONE, 'Perform a dry run without actually deleting conversations.' ],
            [ 'y', null, InputOption::VALUE_NONE, 'Confirm deletion of conversations.' ],
        ];
    }


    /**
     * Execute the console command.
     *
     * @return mixed
     */
    public function handle() {
        $mailboxIds        = $this->option( 'mailbox-id' );
        $statuses          = $this->option( 'status' );
        $olderThanDays     = $this->option( 'older-than-days' );
        $subjectStartsWith = $this->option( 'subject-starts-with' );
        $subjectContains   = $this->option( 'subject-contains' );
        $subjectEndsWith   = $this->option( 'subject-ends-with' );
        $limit             = $this->option( 'limit' );
        $dryRun            = $this->option( 'dry-run' );
        $confirmed         = $this->option( 'y' );

        $conversations = Conversation::query();

        if ( $mailboxIds ) {
            $conversations->whereIn( 'mailbox_id', $mailboxIds );
        }

        if ( $statuses ) {
            $conversations->whereIn( 'status', $statuses );
        }

        if ( $olderThanDays ) {
            $olderThanDate = now()->subDays( $olderThanDays );
            $conversations->where( 'created_at', '<=', $olderThanDate );
        }

        if ( $subjectStartsWith ) {
            $conversations->where( 'subject', 'like', $subjectStartsWith . '%' );
        }

        if ( $subjectContains ) {
            $conversations->where( 'subject', 'like', '%' . $subjectContains . '%' );
        }

        if ( $subjectEndsWith ) {
            $conversations->where( 'subject', 'like', '%' . $subjectEndsWith );
        }

        if ( $limit ) {
            $conversations->limit( $limit );
        }

        $conversationIds = $conversations->pluck( 'id' )->toArray();

        if ( ! $conversationIds ) {
            $this->info( 'No conversations found matching the specified criteria.' );

            return true;
        }

        if ( $dryRun ) {
            $this->info( 'Dry run mode enabled. No conversations were deleted.' );
            $this->info( 'The following conversations would have been deleted:' );
            $this->info( implode( ', ', $conversationIds ) );

            return true;
        }

        if ( ! $confirmed ) {
            $this->info( 'The following conversations will be deleted:' );
            $this->info( implode( ', ', $conversationIds ) );
            $confirmed = $this->confirm( 'Do you wish to proceed?' );
        }

        if ( $confirmed ) {
            $this->info( 'Deleting ' . count( $conversationIds ) . ' conversations...' );
            Conversation::deleteConversationsForever( $conversationIds );
            $this->info( 'Conversations deleted successfully.' );
        } else {
            $this->info( 'Deletion of conversations cancelled.' );
        }

        return true;
    }


}