nextcloud /
server
| Total Complexity | 81 |
| Total Lines | 241 |
| Duplicated Lines | 0 % |
| Changes | 0 | ||
Complex classes like InfoParser often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use InfoParser, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 35 | class InfoParser { |
||
| 36 | /** @var \OCP\ICache|null */ |
||
| 37 | private $cache; |
||
| 38 | |||
| 39 | /** |
||
| 40 | * @param ICache|null $cache |
||
| 41 | */ |
||
| 42 | public function __construct(ICache $cache = null) { |
||
| 44 | } |
||
| 45 | |||
| 46 | /** |
||
| 47 | * @param string $file the xml file to be loaded |
||
| 48 | * @return null|array where null is an indicator for an error |
||
| 49 | */ |
||
| 50 | public function parse($file) { |
||
| 51 | if (!file_exists($file)) { |
||
| 52 | return null; |
||
| 53 | } |
||
| 54 | |||
| 55 | if ($this->cache !== null) { |
||
| 56 | $fileCacheKey = $file . filemtime($file); |
||
| 57 | if ($cachedValue = $this->cache->get($fileCacheKey)) { |
||
| 58 | return json_decode($cachedValue, true); |
||
| 59 | } |
||
| 60 | } |
||
| 61 | |||
| 62 | libxml_use_internal_errors(true); |
||
| 63 | $loadEntities = libxml_disable_entity_loader(false); |
||
| 64 | $xml = simplexml_load_file($file); |
||
| 65 | |||
| 66 | libxml_disable_entity_loader($loadEntities); |
||
| 67 | if ($xml === false) { |
||
| 68 | libxml_clear_errors(); |
||
| 69 | return null; |
||
| 70 | } |
||
| 71 | $array = $this->xmlToArray($xml); |
||
| 72 | |||
| 73 | if (is_null($array)) { |
||
|
introduced
by
|
|||
| 74 | return null; |
||
| 75 | } |
||
| 76 | |||
| 77 | if (!array_key_exists('info', $array)) { |
||
| 78 | $array['info'] = []; |
||
| 79 | } |
||
| 80 | if (!array_key_exists('remote', $array)) { |
||
| 81 | $array['remote'] = []; |
||
| 82 | } |
||
| 83 | if (!array_key_exists('public', $array)) { |
||
| 84 | $array['public'] = []; |
||
| 85 | } |
||
| 86 | if (!array_key_exists('types', $array)) { |
||
| 87 | $array['types'] = []; |
||
| 88 | } |
||
| 89 | if (!array_key_exists('repair-steps', $array)) { |
||
| 90 | $array['repair-steps'] = []; |
||
| 91 | } |
||
| 92 | if (!array_key_exists('install', $array['repair-steps'])) { |
||
| 93 | $array['repair-steps']['install'] = []; |
||
| 94 | } |
||
| 95 | if (!array_key_exists('pre-migration', $array['repair-steps'])) { |
||
| 96 | $array['repair-steps']['pre-migration'] = []; |
||
| 97 | } |
||
| 98 | if (!array_key_exists('post-migration', $array['repair-steps'])) { |
||
| 99 | $array['repair-steps']['post-migration'] = []; |
||
| 100 | } |
||
| 101 | if (!array_key_exists('live-migration', $array['repair-steps'])) { |
||
| 102 | $array['repair-steps']['live-migration'] = []; |
||
| 103 | } |
||
| 104 | if (!array_key_exists('uninstall', $array['repair-steps'])) { |
||
| 105 | $array['repair-steps']['uninstall'] = []; |
||
| 106 | } |
||
| 107 | if (!array_key_exists('background-jobs', $array)) { |
||
| 108 | $array['background-jobs'] = []; |
||
| 109 | } |
||
| 110 | if (!array_key_exists('two-factor-providers', $array)) { |
||
| 111 | $array['two-factor-providers'] = []; |
||
| 112 | } |
||
| 113 | if (!array_key_exists('commands', $array)) { |
||
| 114 | $array['commands'] = []; |
||
| 115 | } |
||
| 116 | if (!array_key_exists('activity', $array)) { |
||
| 117 | $array['activity'] = []; |
||
| 118 | } |
||
| 119 | if (!array_key_exists('filters', $array['activity'])) { |
||
| 120 | $array['activity']['filters'] = []; |
||
| 121 | } |
||
| 122 | if (!array_key_exists('settings', $array['activity'])) { |
||
| 123 | $array['activity']['settings'] = []; |
||
| 124 | } |
||
| 125 | if (!array_key_exists('providers', $array['activity'])) { |
||
| 126 | $array['activity']['providers'] = []; |
||
| 127 | } |
||
| 128 | if (!array_key_exists('settings', $array)) { |
||
| 129 | $array['settings'] = []; |
||
| 130 | } |
||
| 131 | if (!array_key_exists('admin', $array['settings'])) { |
||
| 132 | $array['settings']['admin'] = []; |
||
| 133 | } |
||
| 134 | if (!array_key_exists('admin-section', $array['settings'])) { |
||
| 135 | $array['settings']['admin-section'] = []; |
||
| 136 | } |
||
| 137 | if (!array_key_exists('personal', $array['settings'])) { |
||
| 138 | $array['settings']['personal'] = []; |
||
| 139 | } |
||
| 140 | if (!array_key_exists('personal-section', $array['settings'])) { |
||
| 141 | $array['settings']['personal-section'] = []; |
||
| 142 | } |
||
| 143 | |||
| 144 | if (array_key_exists('types', $array)) { |
||
| 145 | if (is_array($array['types'])) { |
||
| 146 | foreach ($array['types'] as $type => $v) { |
||
| 147 | unset($array['types'][$type]); |
||
| 148 | if (is_string($type)) { |
||
| 149 | $array['types'][] = $type; |
||
| 150 | } |
||
| 151 | } |
||
| 152 | } else { |
||
| 153 | $array['types'] = []; |
||
| 154 | } |
||
| 155 | } |
||
| 156 | if (isset($array['repair-steps']['install']['step']) && is_array($array['repair-steps']['install']['step'])) { |
||
| 157 | $array['repair-steps']['install'] = $array['repair-steps']['install']['step']; |
||
| 158 | } |
||
| 159 | if (isset($array['repair-steps']['pre-migration']['step']) && is_array($array['repair-steps']['pre-migration']['step'])) { |
||
| 160 | $array['repair-steps']['pre-migration'] = $array['repair-steps']['pre-migration']['step']; |
||
| 161 | } |
||
| 162 | if (isset($array['repair-steps']['post-migration']['step']) && is_array($array['repair-steps']['post-migration']['step'])) { |
||
| 163 | $array['repair-steps']['post-migration'] = $array['repair-steps']['post-migration']['step']; |
||
| 164 | } |
||
| 165 | if (isset($array['repair-steps']['live-migration']['step']) && is_array($array['repair-steps']['live-migration']['step'])) { |
||
| 166 | $array['repair-steps']['live-migration'] = $array['repair-steps']['live-migration']['step']; |
||
| 167 | } |
||
| 168 | if (isset($array['repair-steps']['uninstall']['step']) && is_array($array['repair-steps']['uninstall']['step'])) { |
||
| 169 | $array['repair-steps']['uninstall'] = $array['repair-steps']['uninstall']['step']; |
||
| 170 | } |
||
| 171 | if (isset($array['background-jobs']['job']) && is_array($array['background-jobs']['job'])) { |
||
| 172 | $array['background-jobs'] = $array['background-jobs']['job']; |
||
| 173 | } |
||
| 174 | if (isset($array['commands']['command']) && is_array($array['commands']['command'])) { |
||
| 175 | $array['commands'] = $array['commands']['command']; |
||
| 176 | } |
||
| 177 | if (isset($array['two-factor-providers']['provider']) && is_array($array['two-factor-providers']['provider'])) { |
||
| 178 | $array['two-factor-providers'] = $array['two-factor-providers']['provider']; |
||
| 179 | } |
||
| 180 | if (isset($array['activity']['filters']['filter']) && is_array($array['activity']['filters']['filter'])) { |
||
| 181 | $array['activity']['filters'] = $array['activity']['filters']['filter']; |
||
| 182 | } |
||
| 183 | if (isset($array['activity']['settings']['setting']) && is_array($array['activity']['settings']['setting'])) { |
||
| 184 | $array['activity']['settings'] = $array['activity']['settings']['setting']; |
||
| 185 | } |
||
| 186 | if (isset($array['activity']['providers']['provider']) && is_array($array['activity']['providers']['provider'])) { |
||
| 187 | $array['activity']['providers'] = $array['activity']['providers']['provider']; |
||
| 188 | } |
||
| 189 | if (isset($array['collaboration']['collaborators']['searchPlugins']['searchPlugin']) |
||
| 190 | && is_array($array['collaboration']['collaborators']['searchPlugins']['searchPlugin']) |
||
| 191 | && !isset($array['collaboration']['collaborators']['searchPlugins']['searchPlugin']['class']) |
||
| 192 | ) { |
||
| 193 | $array['collaboration']['collaborators']['searchPlugins'] = $array['collaboration']['collaborators']['searchPlugins']['searchPlugin']; |
||
| 194 | } |
||
| 195 | if (isset($array['settings']['admin']) && !is_array($array['settings']['admin'])) { |
||
| 196 | $array['settings']['admin'] = [$array['settings']['admin']]; |
||
| 197 | } |
||
| 198 | if (isset($array['settings']['admin-section']) && !is_array($array['settings']['admin-section'])) { |
||
| 199 | $array['settings']['admin-section'] = [$array['settings']['admin-section']]; |
||
| 200 | } |
||
| 201 | if (isset($array['settings']['personal']) && !is_array($array['settings']['personal'])) { |
||
| 202 | $array['settings']['personal'] = [$array['settings']['personal']]; |
||
| 203 | } |
||
| 204 | if (isset($array['settings']['personal-section']) && !is_array($array['settings']['personal-section'])) { |
||
| 205 | $array['settings']['personal-section'] = [$array['settings']['personal-section']]; |
||
| 206 | } |
||
| 207 | |||
| 208 | if (isset($array['navigations']['navigation']) && $this->isNavigationItem($array['navigations']['navigation'])) { |
||
| 209 | $array['navigations']['navigation'] = [$array['navigations']['navigation']]; |
||
| 210 | } |
||
| 211 | |||
| 212 | if ($this->cache !== null) { |
||
| 213 | $this->cache->set($fileCacheKey, json_encode($array)); |
||
| 214 | } |
||
| 215 | return $array; |
||
| 216 | } |
||
| 217 | |||
| 218 | /** |
||
| 219 | * @param $data |
||
| 220 | * @return bool |
||
| 221 | */ |
||
| 222 | private function isNavigationItem($data): bool { |
||
| 223 | return isset($data['name'], $data['route']); |
||
| 224 | } |
||
| 225 | |||
| 226 | /** |
||
| 227 | * @param \SimpleXMLElement $xml |
||
| 228 | * @return array |
||
| 229 | */ |
||
| 230 | public function xmlToArray($xml) { |
||
| 276 | } |
||
| 277 | } |
||
| 278 |
Loading history...
