firefly-iii / firefly-iii

app/Export/Collector/UploadCollector.php

<?php
/**
 * UploadCollector.php
 * Copyright (c) 2018 thegrumpydictator@gmail.com
 *
 * This file is part of Firefly III.
 *
 * Firefly III is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Firefly III is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Firefly III. If not, see <http://www.gnu.org/licenses/>.
 */

declare(strict_types=1);

namespace FireflyIII\Export\Collector;

use Crypt;
use Exception;
use Illuminate\Contracts\Encryption\DecryptException;
use Log;
use Storage;

/**
 * Class UploadCollector.
 *
 * @codeCoverageIgnore
 * @deprecated
 */
class UploadCollector extends BasicCollector implements CollectorInterface

The class FireflyIII\Export\Collector\BasicCollector has been deprecated.

The interface FireflyIII\Export\Collector\CollectorInterface has been deprecated.

{
    /** @var \Illuminate\Contracts\Filesystem\Filesystem */
    private $exportDisk;
    /** @var \Illuminate\Contracts\Filesystem\Filesystem */
    private $uploadDisk;

    /**
     * AttachmentCollector constructor.
     */
    public function __construct()
    {
        parent::__construct();
        $this->uploadDisk = Storage::disk('upload');
        $this->exportDisk = Storage::disk('export');
    }

    /**
     * Is called from the outside to actually start the export.
     *
     * @return bool
     */
    public function run(): bool
    {
        Log::debug('Going to collect attachments', ['key' => $this->job->key]);
        $this->collectModernUploads();

        return true;
    }

    /**
     * This method collects all the uploads that are uploaded using the new importer. So after the summer of 2016.
     *
     * @return bool
     */
    private function collectModernUploads(): bool
    {
        $set = $this->job->user->importJobs()->whereIn('status', ['import_complete', 'finished'])->get(['import_jobs.*']);
        Log::debug(sprintf('Found %d import jobs', $set->count()));
        $keys = [];
        if ($set->count() > 0) {
            $keys = $set->pluck('key')->toArray();
        }

        foreach ($keys as $key) {
            $this->processModernUpload($key);
        }

        return true;
    }

    /** @noinspection MultipleReturnStatementsInspection */
    /**
     * Process new file uploads.
     *
     * @param string $key
     *
     * @return bool
     */
    private function processModernUpload(string $key): bool
    {
        // find job associated with import file:
        $job = $this->job->user->importJobs()->where('key', $key)->first();
        if (null === $job) {
            return false;
        }

        // find the file for this import:
        $content = '';

The assignment to $content is dead and can be removed.

        try {
            $content = Crypt::decrypt($this->uploadDisk->get(sprintf('%s.upload', $key)));
        } catch (Exception | DecryptException $e) {
            Log::error(sprintf('Could not decrypt old import file "%s". Skipped because: %s', $key, $e->getMessage()));
        }

        if ('' !== $content) {
            // add to export disk.
            $date = $job->created_at->format('Y-m-d');
            $file = sprintf('%s-Old %s import dated %s.%s', $this->job->key, strtoupper($job->file_type), $date, $job->file_type);
            $this->exportDisk->put($file, $content);
            $this->getEntries()->push($file);
        }

        return true;
    }
}