Passed
Pull Request — main (#11)
by Dante
08:00 queued 06:56
created

AnonymizeUsersCommand::execute()   B

Complexity

Conditions 5
Paths 18

Size

Total Lines 49
Code Lines 39

Duplication

Lines 0
Ratio 0 %

Importance

Changes 2
Bugs 1 Features 0
Metric Value
eloc 39
c 2
b 1
f 0
dl 0
loc 49
rs 8.9848
cc 5
nc 18
nop 2
1
<?php
2
declare(strict_types=1);
3
4
/**
5
 * BEdita, API-first content management framework
6
 * Copyright 2024 Atlas Srl, Chialab Srl
7
 *
8
 * This file is part of BEdita: you can redistribute it and/or modify
9
 * it under the terms of the GNU Lesser General Public License as published
10
 * by the Free Software Foundation, either version 3 of the License, or
11
 * (at your option) any later version.
12
 *
13
 * See LICENSE.LGPL or <http://gnu.org/licenses/lgpl-3.0.html> for more details.
14
 */
15
16
namespace BEdita\ImportTools\Command;
17
18
use BEdita\Core\Utility\LoggedUser;
19
use Cake\Command\Command;
20
use Cake\Console\Arguments;
21
use Cake\Console\ConsoleIo;
22
use Cake\Console\ConsoleOptionParser;
23
use Cake\ORM\Query;
24
use Cake\Utility\Text;
25
use Faker\Factory;
26
27
/**
28
 * Anonymize users command.
29
 */
30
class AnonymizeUsersCommand extends Command
31
{
32
    /**
33
     * Users to preserve by id.
34
     *
35
     * @var array
36
     */
37
    protected array $preserveUsers = [
38
        1, // admin
39
    ];
40
41
    /**
42
     * @inheritDoc
43
     */
44
    public function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser
45
    {
46
        return parent::buildOptionParser($parser)
47
            ->addOptions([
48
                'id' => [
49
                    'help' => 'User id',
50
                ],
51
                'preserve' => [
52
                    'help' => 'Users to preserve by id',
53
                    'default' => '1',
54
                ],
55
            ]);
56
    }
57
58
    /**
59
     * {@inheritDoc}
60
     *
61
     * Anonymize Users command.
62
     *
63
     * $ bin/cake anonymize_users --help
64
     *
65
     * Usage:
66
     * cake anonymize_users [options]
67
     *
68
     * Options:
69
     *
70
     * --id           User id
71
     * --preserve     Users to preserve by id
72
     * --help, -h     Display this help.
73
     * --verbose, -v  Enable verbose output.
74
     *
75
     * # basic
76
     * $ bin/cake anonymize_users --id 2
77
     * $ bin/cake anonymize_users --preserve 1,2,3
78
     */
79
    public function execute(Arguments $args, ConsoleIo $io)
80
    {
81
        $io->success('Start.');
82
        LoggedUser::setUserAdmin();
83
        /** @var \BEdita\Core\Model\Table\UsersTable $table */
84
        $table = $this->fetchTable('Users');
85
        $this->preserveUsers = array_map('intval', explode(',', $args->getOption('preserve')));
86
        $query = $table->find()
87
            ->where([
88
                $table->aliasField('locked') => 0,
89
                $table->aliasField('deleted') => 0,
90
                $table->aliasField('id') . ' NOT IN' => $this->preserveUsers,
91
            ]);
92
        $id = $args->getOption('id');
93
        if ($id) {
94
            $query->where([$table->aliasField('id') => $id]);
95
        }
96
        $faker = Factory::create('it_IT');
97
        $processed = $saved = $errors = 0;
98
        /** @var \BEdita\Core\Model\Entity\User $user */
99
        foreach ($this->objectsGenerator($query) as $user) {
100
            $io->verbose(sprintf('Processing user %s [username: %s, email: %s]', $user->id, $user->username, $user->email));
101
            $user->name = $faker->firstName();
102
            $user->surname = $faker->lastName();
103
            $email = $faker->email();
104
            while ($table->exists([$table->aliasField('email') => $email])) {
105
                $email = $faker->email();
106
            }
107
            $user->email = $email;
108
            $user->uname = sprintf('user-%s', Text::uuid());
109
            $user->username = $email;
110
            $processed++;
111
            try {
112
                $table->saveOrFail($user);
113
                $this->log(sprintf('[OK] User %s updated', $user->id), 'debug');
114
                $saved++;
115
                $io->verbose(sprintf('Saved %s as [username: %s, email: %s]', $user->id, $user->username, $user->email));
116
            } catch (\Exception $e) {
117
                $this->log(sprintf('[KO] User %s not updated', $user->id), 'error');
118
                $errors++;
119
                $io->verbose(sprintf('Error %s as [username: %s, email: %s]', $user->id, $user->username, $user->email));
120
            }
121
        }
122
        $io->out(sprintf('Users processed: %s', $processed));
123
        $io->out(sprintf('Users saved: %s', $saved));
124
        $io->out(sprintf('Users not saved: %s', $errors));
125
        $io->success('Done.');
126
127
        return null;
128
    }
129
130
    /**
131
     * Objects generator.
132
     *
133
     * @param \Cake\ORM\Query $query Query object
134
     * @return \Generator
135
     */
136
    protected function objectsGenerator(Query $query): \Generator
137
    {
138
        $pageSize = 1000;
139
        $pages = ceil($query->count() / $pageSize);
140
        for ($page = 1; $page <= $pages; $page++) {
141
            yield from $query
142
                ->page($page, $pageSize)
143
                ->toArray();
144
        }
145
    }
146
}
147