Actions::createTree() - Code Metrics - alex-kalanis/kw_user_paths - Measure and Improve Code Quality continuously with Scrutinizer

Actions::createTree() A
last analyzed 2024-04-05 00:51 UTC

↳ Parent: Actions

Complexity

Conditions	6
Paths	11

Size

Total Lines	18
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	13
CRAP Score	6

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	6
eloc	12
c	1
b	0
f	0
nc	11
nop	0
dl	0
loc	18
ccs	13
cts	13
cp	1
crap	6
rs	9.2222

<?php

namespace kalanis\kw_user_paths;


use kalanis\kw_files\FilesException;
use kalanis\kw_files\Interfaces\IProcessDirs;
use kalanis\kw_files\Interfaces\IProcessNodes;
use kalanis\kw_paths\ArrayPath;
use kalanis\kw_paths\Interfaces\IPaths;
use kalanis\kw_paths\PathsException;
use kalanis\kw_user_paths\Traits\TLang;


/**
 * Class Actions
 * low-level work with user dirs
 */
class Actions
{
    use TLang;

    protected UserDir $data;
    protected IProcessNodes $nodes;
    protected IProcessDirs $dirs;

    public function __construct(UserDir $data, IProcessNodes $nodes, IProcessDirs $dirs, ?Interfaces\IUPTranslations $lang = null)
    {
        $this->data = $data;
        $this->nodes = $nodes;
        $this->dirs = $dirs;
        $this->setUpLang($lang);
    }

    /**
     * Create inner path tree
     * @throws PathsException
     * @throws FilesException
     * @return string with inner path
     */
    public function createTree(): string
    {
        $path = $this->data->getFullPath();
        if ($this->isNoPathSet($path)) {
            throw new PathsException($this->getUpLang()->upCannotDetermineUserDir());
        }
        $userPath = $this->data->hasDataDir() ? $path->getArrayDirectory() : $path->getArray();
        if (!$this->dirs->createDir($userPath)) {
            if (!$this->nodes->isDir($userPath)) {
                throw new PathsException($this->getUpLang()->upCannotCreateUserDir());
            }
        }
        if ($this->data->hasDataDir()) {
            $this->dirs->createDir(array_merge($userPath, [IPaths::DIR_DATA]));
            $this->dirs->createDir(array_merge($userPath, [IPaths::DIR_CONF]));
            $this->dirs->createDir(array_merge($userPath, [IPaths::DIR_STYLE]));
        }
        return $path->getString();
    }

    /**
     * Remove data in user's work dir
     * @throws PathsException
     * @throws FilesException
     * @return bool
     */
    public function wipeWorkDir(): bool
    {
        $path = $this->data->getFullPath();
        if ($this->isNoPathSet($path)) {
            throw new PathsException($this->getUpLang()->upCannotDetermineUserDir());
        }
        if ($this->isPathTooShort($path)) { # There surely will be an idiot who want to remove root data
            return false;
        }
        $whichPath = $this->data->hasDataDir()
            ? array_merge($path->getArrayDirectory(), [IPaths::DIR_DATA])
            : $path->getArray();
        return $this->dirs->deleteDir($whichPath, true);
    }

    /**
     * Remove everything in user's special sub dirs
     * @throws PathsException
     * @throws FilesException
     * @return bool
     */
    public function wipeConfDirs(): bool
    {
        $path = $this->data->getFullPath();
        if ($this->isNoPathSet($path)) {
            throw new PathsException($this->getUpLang()->upCannotDetermineUserDir());
        }
        if ($this->isPathTooShort($path)) { # There surely will be an idiot who want to remove root data
            return false;
        }
        if (!$this->data->hasDataDir()) {
            return false;
        }
        $userPath = $path->getArrayDirectory();
        $r1 = $this->dirs->deleteDir(array_merge($userPath, [IPaths::DIR_CONF]), true);
        $r2 = $this->dirs->deleteDir(array_merge($userPath, [IPaths::DIR_STYLE]), true);
        return $r1 && $r2;
    }

    /**
     * Remove everything in user's home dir and that home dir itself
     * @throws PathsException
     * @throws FilesException
     * @return bool
     */
    public function wipeHomeDir(): bool
    {
        $path = $this->data->getFullPath();
        if ($this->isNoPathSet($path)) {
            throw new PathsException($this->getUpLang()->upCannotDetermineUserDir());
        }
        if ($this->isPathTooShort($path)) {
            return false; # urcite se najde i blbec, co bude chtit wipe roota (jeste blbejsi napad, nez jsme doufali) - tudy se odinstalace fakt nedela!
        }
        $userPath = $this->data->hasDataDir() ? $path->getArrayDirectory() : $path->getArray();
        $r1 = $this->dirs->deleteDir($userPath, true);
        $this->data->clear();
        return $r1;
    }

    /**
     * @param ArrayPath $path
     * @throws PathsException
     * @return bool
     */
    protected function isNoPathSet(ArrayPath $path): bool
    {
        return empty($path->getString());
    }

    /**
     * @param ArrayPath $path
     * @throws PathsException
     * @return bool
     */
    protected function isPathTooShort(ArrayPath $path): bool
    {
        return (3 > strlen($path->getString()));
    }
}

/*
//// how it works ////

// create user, its dir, subdirs will be made auto
$u = new UserDir();
$u->setUserName("nom");
$u->process();
$src = 'somewhere/on/volume';
$a = new Actions($u, new \kalanis\kw_files\Processing\Volume\ProcessNode($src), new \kalanis\kw_files\Processing\Volume\ProcessDir($src));
$a->createTree();

// when you do not need subdirs; sometimes necessary
$u->wantDataDir(false);

// user removal
$u = new UserDir();
$u->setUserName("nom"); || $u->setUserPath("dat/dumb/dir");
$u->process();
$src = 'somewhere/on/volume';
$a = new Actions($u, new \kalanis\kw_files\Processing\Volume\ProcessNode($src), new \kalanis\kw_files\Processing\Volume\ProcessDir($src));
$a->wipeWorkDir(); || $a->wipeConfDirs(); || $a->wipeHomeDir(); // by the request and feel

// create subdirs when they aren't
$u = new UserDir();
$u->setUserName("nom"); || $u->setUserPath("dat/dumb/dir");
$u->wantDataDir(true);
$u->process();
$a = new Actions($u, new \kalanis\kw_files\Processing\Volume\ProcessNode($src), new \kalanis\kw_files\Processing\Volume\ProcessDir($src));
$a->createTree();

// then it's good idea to write that updated form into password file - or the user will see strange things
$where = $u->getUserPath();

// current user and its files
$u = new UserDir();
$u->setUserName("nom"); || $u->setUserPath("dat/dumb/dir");
$u->process();
$where = $u->getUserPath();

// did that user have home dir and/or subdirs?
$homedir = $u->hasHomeDir(); // beware, returns bool
$subdirs = $u->hasDataDir(); // beware, returns bool
*/



1		<?php
2
3		namespace kalanis\kw_user_paths;
4
5
6		use kalanis\kw_files\FilesException;
7		use kalanis\kw_files\Interfaces\IProcessDirs;
8		use kalanis\kw_files\Interfaces\IProcessNodes;
9		use kalanis\kw_paths\ArrayPath;
10		use kalanis\kw_paths\Interfaces\IPaths;
11		use kalanis\kw_paths\PathsException;
12		use kalanis\kw_user_paths\Traits\TLang;
13
14
15		/**
16		* Class Actions
17		* low-level work with user dirs
18		*/
19		class Actions
20		{
21		use TLang;
22
23		protected UserDir $data;
24		protected IProcessNodes $nodes;
25		protected IProcessDirs $dirs;
26
27	14	public function __construct(UserDir $data, IProcessNodes $nodes, IProcessDirs $dirs, ?Interfaces\IUPTranslations $lang = null)
28		{
29	14	$this->data = $data;
30	14	$this->nodes = $nodes;
31	14	$this->dirs = $dirs;
32	14	$this->setUpLang($lang);
33	14	}
34
35		/**
36		* Create inner path tree
37		* @throws PathsException
38		* @throws FilesException
39		* @return string with inner path
40		*/
41	3	public function createTree(): string
42		{
43	3	$path = $this->data->getFullPath();
44	3	if ($this->isNoPathSet($path)) {
45	1	throw new PathsException($this->getUpLang()->upCannotDetermineUserDir());
46		}
47	2	$userPath = $this->data->hasDataDir() ? $path->getArrayDirectory() : $path->getArray();
48	2	if (!$this->dirs->createDir($userPath)) {
49	1	if (!$this->nodes->isDir($userPath)) {
50	1	throw new PathsException($this->getUpLang()->upCannotCreateUserDir());
51		}
52		}
53	1	if ($this->data->hasDataDir()) {
54	1	$this->dirs->createDir(array_merge($userPath, [IPaths::DIR_DATA]));
55	1	$this->dirs->createDir(array_merge($userPath, [IPaths::DIR_CONF]));
56	1	$this->dirs->createDir(array_merge($userPath, [IPaths::DIR_STYLE]));
57		}
58	1	return $path->getString();
59		}
60
61		/**
62		* Remove data in user's work dir
63		* @throws PathsException
64		* @throws FilesException
65		* @return bool
66		*/
67	4	public function wipeWorkDir(): bool
68		{
69	4	$path = $this->data->getFullPath();
70	4	if ($this->isNoPathSet($path)) {
71	1	throw new PathsException($this->getUpLang()->upCannotDetermineUserDir());
72		}
73	3	if ($this->isPathTooShort($path)) { # There surely will be an idiot who want to remove root data
74	1	return false;
75		}
76	2	$whichPath = $this->data->hasDataDir()
77	1	? array_merge($path->getArrayDirectory(), [IPaths::DIR_DATA])
78	2	: $path->getArray();
79	2	return $this->dirs->deleteDir($whichPath, true);
80		}
81
82		/**
83		* Remove everything in user's special sub dirs
84		* @throws PathsException
85		* @throws FilesException
86		* @return bool
87		*/
88	5	public function wipeConfDirs(): bool
89		{
90	5	$path = $this->data->getFullPath();
91	5	if ($this->isNoPathSet($path)) {
92	1	throw new PathsException($this->getUpLang()->upCannotDetermineUserDir());
93		}
94	4	if ($this->isPathTooShort($path)) { # There surely will be an idiot who want to remove root data
95	1	return false;
96		}
97	3	if (!$this->data->hasDataDir()) {
98	1	return false;
99		}
100	2	$userPath = $path->getArrayDirectory();
101	2	$r1 = $this->dirs->deleteDir(array_merge($userPath, [IPaths::DIR_CONF]), true);
102	2	$r2 = $this->dirs->deleteDir(array_merge($userPath, [IPaths::DIR_STYLE]), true);
103	2	return $r1 && $r2;
104		}
105
106		/**
107		* Remove everything in user's home dir and that home dir itself
108		* @throws PathsException
109		* @throws FilesException
110		* @return bool
111		*/
112	4	public function wipeHomeDir(): bool
113		{
114	4	$path = $this->data->getFullPath();
115	4	if ($this->isNoPathSet($path)) {
116	1	throw new PathsException($this->getUpLang()->upCannotDetermineUserDir());
117		}
118	3	if ($this->isPathTooShort($path)) {
119	1	return false; # urcite se najde i blbec, co bude chtit wipe roota (jeste blbejsi napad, nez jsme doufali) - tudy se odinstalace fakt nedela!
120		}
121	2	$userPath = $this->data->hasDataDir() ? $path->getArrayDirectory() : $path->getArray();
122	2	$r1 = $this->dirs->deleteDir($userPath, true);
123	2	$this->data->clear();
124	2	return $r1;
125		}
126
127		/**
128		* @param ArrayPath $path
129		* @throws PathsException
130		* @return bool
131		*/
132	14	protected function isNoPathSet(ArrayPath $path): bool
133		{
134	14	return empty($path->getString());
135		}
136
137		/**
138		* @param ArrayPath $path
139		* @throws PathsException
140		* @return bool
141		*/
142	9	protected function isPathTooShort(ArrayPath $path): bool
143		{
144	9	return (3 > strlen($path->getString()));
145		}
146		}
147
148		/*
149		//// how it works ////
150
151		// create user, its dir, subdirs will be made auto
152		$u = new UserDir();
153		$u->setUserName("nom");
154		$u->process();
155		$src = 'somewhere/on/volume';
156		$a = new Actions($u, new \kalanis\kw_files\Processing\Volume\ProcessNode($src), new \kalanis\kw_files\Processing\Volume\ProcessDir($src));
157		$a->createTree();
158
159		// when you do not need subdirs; sometimes necessary
160		$u->wantDataDir(false);
161
162		// user removal
163		$u = new UserDir();
164		$u->setUserName("nom"); \|\| $u->setUserPath("dat/dumb/dir");
165		$u->process();
166		$src = 'somewhere/on/volume';
167		$a = new Actions($u, new \kalanis\kw_files\Processing\Volume\ProcessNode($src), new \kalanis\kw_files\Processing\Volume\ProcessDir($src));
168		$a->wipeWorkDir(); \|\| $a->wipeConfDirs(); \|\| $a->wipeHomeDir(); // by the request and feel
169
170		// create subdirs when they aren't
171		$u = new UserDir();
172		$u->setUserName("nom"); \|\| $u->setUserPath("dat/dumb/dir");
173		$u->wantDataDir(true);
174		$u->process();
175		$a = new Actions($u, new \kalanis\kw_files\Processing\Volume\ProcessNode($src), new \kalanis\kw_files\Processing\Volume\ProcessDir($src));
176		$a->createTree();
177
178		// then it's good idea to write that updated form into password file - or the user will see strange things
179		$where = $u->getUserPath();
180
181		// current user and its files
182		$u = new UserDir();
183		$u->setUserName("nom"); \|\| $u->setUserPath("dat/dumb/dir");
184		$u->process();
185		$where = $u->getUserPath();
186
187		// did that user have home dir and/or subdirs?
188		$homedir = $u->hasHomeDir(); // beware, returns bool
189		$subdirs = $u->hasDataDir(); // beware, returns bool
190		*/
191
192

alex-kalanis / kw_user_paths

Actions::createTree() A last analyzed 2024-04-05 00:51 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Actions::createTree() A
last analyzed 2024-04-05 00:51 UTC