janis91 /
ocr
| Conditions | 5 |
| Paths | 16 |
| Total Lines | 270 |
| Lines | 0 |
| Ratio | 0 % |
| Changes | 0 | ||
Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.
For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.
Commonly applied refactorings include:
If many parameters/temporary variables are present:
| 1 | /** |
||
| 20 | var Controller = function (view, util, httpService) { |
||
| 21 | /** Constructor */ |
||
| 22 | /** Instance of the OCA.Ocr.View. */ |
||
| 23 | var ocrView; |
||
| 24 | view !== undefined ? ocrView = view : console.error('OCR view is not defined.'); |
||
| 25 | /** Instance of the OCA.Ocr.Util. */ |
||
| 26 | var ocrUtil; |
||
| 27 | util !== undefined ? ocrUtil = util : console.error('OCR util is not defined.'); |
||
| 28 | /** Instance of the OCA.Ocr.HttpService. */ |
||
| 29 | var ocrHttpService; |
||
| 30 | httpService !== undefined ? ocrHttpService = httpService : console.error('OCR http service is not defined.'); |
||
| 31 | /** Load the languages that are available for processing. */ |
||
| 32 | var languages = ocrHttpService.loadAvailableLanguages(); |
||
| 33 | languages.length > 0 ? '' : console.error('No languages available for OCR processing. Please make sure, that the Docker Container is up and running.'); |
||
| 34 | /** Currently selected files. */ |
||
| 35 | var selectedFiles = []; |
||
| 36 | /** Current status. */ |
||
| 37 | var status = {}; |
||
| 38 | |||
| 39 | /** |
||
| 40 | * Sets the filtered/cleaned selectedFiles array. |
||
| 41 | * @private |
||
| 42 | * @param {Array<File>} files |
||
| 43 | */ |
||
| 44 | var setSelectedFiles = function (files) { |
||
| 45 | files = ocrUtil.shrinkData(ocrUtil.filterFilesWithMimeTypes(files)); |
||
| 46 | selectedFiles = files; |
||
| 47 | } |
||
| 48 | |||
| 49 | /** |
||
| 50 | * Gets the selectedFiles array |
||
| 51 | * @private |
||
| 52 | * @returns {Array<File>} |
||
| 53 | */ |
||
| 54 | var getSelectedFiles = function () { |
||
| 55 | return selectedFiles; |
||
| 56 | } |
||
| 57 | |||
| 58 | /** |
||
| 59 | * Sets the retrieved status. |
||
| 60 | * @private |
||
| 61 | * @param {Object} status |
||
| 62 | */ |
||
| 63 | var setStatus = function (state) { |
||
| 64 | status = state; |
||
| 65 | } |
||
| 66 | |||
| 67 | /** |
||
| 68 | * Gets the retrieved status. |
||
| 69 | * @private |
||
| 70 | * @returns {Object} |
||
| 71 | */ |
||
| 72 | var getStatus = function () { |
||
| 73 | return status; |
||
| 74 | } |
||
| 75 | |||
| 76 | /** |
||
| 77 | * Checks if the click events target was the OCR dropdown or not. |
||
| 78 | * @param {Event} event |
||
| 79 | */ |
||
| 80 | var clickOnOtherEvent = function (event) { |
||
| 81 | ocrView.checkClickOther(event) ? setSelectedFiles([]) : ''; |
||
| 82 | } |
||
| 83 | |||
| 84 | /** |
||
| 85 | * Triggers the rendering of the OCR dropdown for a single file action. |
||
| 86 | * Is the Actionhandler which is registered within the registerFileActions method. |
||
| 87 | * @link registerFileActions |
||
| 88 | * @private |
||
| 89 | * @param {*} file |
||
| 90 | * @param {*} context |
||
| 91 | */ |
||
| 92 | var fileActionHandler = function (file, context) { |
||
| 93 | var id = context.$file.attr('data-id'); |
||
| 94 | var mimetype = context.fileActions.getCurrentMimeType(); |
||
| 95 | var files = [{ id: id, mimetype: mimetype }]; |
||
| 96 | setSelectedFiles(files); |
||
| 97 | ocrView.renderFileAction(file, languages); |
||
| 98 | } |
||
| 99 | |||
| 100 | /** |
||
| 101 | * Registers the FileAction options in the file actions menu for pdf and images. |
||
| 102 | * @private |
||
| 103 | */ |
||
| 104 | var registerFileActions = function () { |
||
| 105 | // Register FileAction for mimetype pdf |
||
| 106 | OCA.Files.fileActions.registerAction({ |
||
| 107 | name: 'Ocr', |
||
| 108 | displayName: t('ocr', 'OCR'), |
||
| 109 | order: 100, |
||
| 110 | mime: 'application/pdf', |
||
| 111 | permissions: OC.PERMISSION_UPDATE, |
||
| 112 | altText: t('ocr', 'OCR'), |
||
| 113 | iconClass: 'icon-ocr', |
||
| 114 | actionHandler: fileActionHandler |
||
| 115 | }); |
||
| 116 | // Register FileAction for mimetype image |
||
| 117 | OCA.Files.fileActions.registerAction({ |
||
| 118 | name: 'Ocr', |
||
| 119 | displayName: t('ocr', 'OCR'), |
||
| 120 | order: 100, |
||
| 121 | mime: 'image', |
||
| 122 | permissions: OC.PERMISSION_UPDATE, |
||
| 123 | altText: t('ocr', 'OCR'), |
||
| 124 | iconClass: 'icon-ocr', |
||
| 125 | actionHandler: fileActionHandler |
||
| 126 | }); |
||
| 127 | } |
||
| 128 | |||
| 129 | /** |
||
| 130 | * Triggers the rendering of the OCR dropdown for the top bar |
||
| 131 | * selected files action button and sets the selectedFiles. |
||
| 132 | * @private |
||
| 133 | */ |
||
| 134 | var clickOnTopBarSelectedFilesActionButton = function () { |
||
| 135 | ocrView.renderFileAction(undefined, languages); |
||
| 136 | setSelectedFiles(OCA.Files.App.fileList.getSelectedFiles()); |
||
| 137 | } |
||
| 138 | |||
| 139 | /** |
||
| 140 | * Triggers the view to show the selected files action button in the top bar |
||
| 141 | * and sets the selectedFiles array. |
||
| 142 | * @private |
||
| 143 | */ |
||
| 144 | var toggleSelectedFilesActionButton = function () { |
||
| 145 | var selFiles = OCA.Files.App.fileList.getSelectedFiles(); |
||
| 146 | if (selFiles.length > 0 && typeof selFiles !== undefined) { |
||
| 147 | ocrView.toggleSelectedFilesActionButton(true); |
||
| 148 | setSelectedFiles(selFiles); |
||
| 149 | } else { |
||
| 150 | ocrView.toggleSelectedFilesActionButton(false); |
||
| 151 | setSelectedFiles([]); |
||
| 152 | } |
||
| 153 | } |
||
| 154 | |||
| 155 | /** |
||
| 156 | * Triggers the view to hide the selected files action button in the top bar |
||
| 157 | * and empties the selectedFiles array. |
||
| 158 | * @private |
||
| 159 | */ |
||
| 160 | var hideSelectedFilesActionButton = function () { |
||
| 161 | ocrView.toggleSelectedFilesActionButton(false); |
||
| 162 | setSelectedFiles([]); |
||
| 163 | } |
||
| 164 | |||
| 165 | /** |
||
| 166 | * Retrieves the status of the OCR process. |
||
| 167 | * @private |
||
| 168 | * @returns {$.Deferred} |
||
| 169 | */ |
||
| 170 | var checkStatus = function () { |
||
| 171 | var deferred = $.Deferred(); |
||
| 172 | ocrHttpService.checkStatus().done(function (status) { |
||
| 173 | setStatus(status); |
||
| 174 | deferred.resolve(status); |
||
| 175 | }).fail(function (jqXHR) { |
||
| 176 | deferred.reject(jqXHR.responseText); |
||
| 177 | }); |
||
| 178 | return deferred.promise(); |
||
| 179 | } |
||
| 180 | |||
| 181 | /** |
||
| 182 | * Reloads the OCA.Files.App.fileList. |
||
| 183 | * @private |
||
| 184 | */ |
||
| 185 | var updateFileList = function () { |
||
| 186 | OCA.Files.App.fileList.reload(); |
||
| 187 | toggleSelectedActionButton(); |
||
| 188 | } |
||
| 189 | |||
| 190 | /** |
||
| 191 | * Trigger the pending notification for the first time (with initialcount) |
||
| 192 | * or after that without initialcount (undefined). |
||
| 193 | * @private |
||
| 194 | * @param {boolean} force - If new files in queue or already in the regular loop. |
||
| 195 | * @param {number} initialcount - How much files initially to process (number or undefined). |
||
| 196 | */ |
||
| 197 | var togglePendingState = function (force, initialcount) { |
||
| 198 | var count; |
||
| 199 | var pendingcount = getStatus().pending; |
||
| 200 | initialcount !== undefined ? count = initialcount : count = pendingcount; |
||
| 201 | ocrView.togglePendingNotification(force, count); |
||
| 202 | } |
||
| 203 | |||
| 204 | /** |
||
| 205 | * Loops as long as there are pending files in the OCR queue. |
||
| 206 | * @private |
||
| 207 | */ |
||
| 208 | var loopForStatus = function () { |
||
| 209 | $.when(checkStatus()).done(function () { |
||
| 210 | if (getStatus().failed > 0) { ocrView.displayError(n('ocr', 'OCR processing for %n file failed. For details please go to your personal settings.', 'OCR processing for %n files failed. For details please go to your personal settings.', getStatus().failed)); } |
||
| 211 | if (getStatus().pending > 0) { |
||
| 212 | if (getStatus().processed > 0) { updateFileList(); } |
||
| 213 | togglePendingState(false); |
||
| 214 | setTimeout($.proxy(loopForStatus, this), 4500); |
||
| 215 | } else { |
||
| 216 | if (getStatus().processed > 0) { updateFileList(); } |
||
| 217 | togglePendingState(false); |
||
| 218 | } |
||
| 219 | }).fail(function (message) { |
||
| 220 | ocrView.displayError(t('ocr', 'OCR status could not be retrieved:') + ' ' + message); |
||
| 221 | setTimeout($.proxy(loopForStatus, self), 4500); |
||
| 222 | }); |
||
| 223 | } |
||
| 224 | |||
| 225 | /** |
||
| 226 | * Triggers the OCR process for the selectedFiles array |
||
| 227 | * and toggles the "pending" state for the ocr process. |
||
| 228 | * @private |
||
| 229 | */ |
||
| 230 | var clickOnProcessButtonEvent = function () { |
||
| 231 | if (getSelectedFiles().length == 0) { |
||
| 232 | ocrView.displayError(t('ocr', 'OCR processing failed:') + ' ' + t('ocr', 'Mimetype not supported.')); |
||
| 233 | ocrView.destroyDropdown(); |
||
| 234 | } else { |
||
| 235 | var selectedLanguages = $('#ocrLanguage').select2('val'); |
||
| 236 | ocrHttpService.process(getSelectedFiles(), selectedLanguages).done(function (status) { |
||
| 237 | togglePendingState(true, getSelectedFiles().length); |
||
| 238 | setSelectedFiles([]); |
||
| 239 | setTimeout($.proxy(loopForStatus, this), 4500); |
||
| 240 | }).fail(function (jqXHR) { |
||
| 241 | ocrView.displayError(t('ocr', 'OCR processing failed:') + ' ' + jqXHR.responseText); |
||
| 242 | }).always(function () { |
||
| 243 | ocrView.destroyDropdown(); |
||
| 244 | }); |
||
| 245 | } |
||
| 246 | } |
||
| 247 | |||
| 248 | /** |
||
| 249 | * Registers the events and the appropriate methods of the view. |
||
| 250 | * @private |
||
| 251 | */ |
||
| 252 | var registerEvents = function () { |
||
| 253 | // Click on another element then the dropdown |
||
| 254 | $(document).click(function (event) { |
||
| 255 | clickOnOtherEvent(event); |
||
| 256 | }); |
||
| 257 | // Click on process button |
||
| 258 | $(document).on('click', '#processOCR', function () { |
||
| 259 | clickOnProcessButtonEvent(); |
||
| 260 | }); |
||
| 261 | // Click on top bar OCR button |
||
| 262 | $(document).on('click', '#selectedFilesOCR', function () { |
||
| 263 | clickOnTopBarSelectedFilesActionButton(); |
||
| 264 | return false; |
||
| 265 | }); |
||
| 266 | |||
| 267 | // Register click events on file menu OCR option |
||
| 268 | registerFileActions(); |
||
| 269 | |||
| 270 | // Register checkbox events |
||
| 271 | _.defer(function () { |
||
| 272 | OCA.Files.App.fileList.$fileList.on('change', 'td.filename>.selectCheckBox', _.bind(toggleSelectedFilesActionButton, this)); |
||
| 273 | OCA.Files.App.fileList.$el.find('.select-all').click(_.bind(toggleSelectedFilesActionButton, this)); |
||
| 274 | OCA.Files.App.fileList.$el.find('.delete-selected').click(_.bind(hideSelectedFilesActionButton, this)); |
||
| 275 | }); |
||
| 276 | } |
||
| 277 | |||
| 278 | this.init = function () { |
||
| 279 | registerEvents(); |
||
| 280 | ocrView.renderSelectedFilesActionButton(); |
||
| 281 | loopForStatus(); |
||
| 282 | } |
||
| 283 | |||
| 284 | this.destroy = function () { |
||
| 285 | ocrView.destroy(); |
||
| 286 | OCA.Files.fileActions.clear(); |
||
| 287 | OCA.Files.fileActions.registerDefaultActions(); |
||
| 288 | } |
||
| 289 | } |
||
| 290 | |||
| 310 |
Loading history...