BookStack Code Mirror - bookstack/blob - resources/assets/js/controllers.js

   1 "use strict";
   2
   3 const moment = require('moment');
   4 require('moment/locale/en-gb');
   5 const editorOptions = require("./pages/page-form");
   6
   7 moment.locale('en-gb');
   8
   9 module.exports = function (ngApp, events) {
  10
  11     ngApp.controller('ImageManagerController', ['$scope', '$attrs', '$http', '$timeout', 'imageManagerService',
  12         function ($scope, $attrs, $http, $timeout, imageManagerService) {
  13
  14             $scope.images = [];
  15             $scope.imageType = $attrs.imageType;
  16             $scope.selectedImage = false;
  17             $scope.dependantPages = false;
  18             $scope.showing = false;
  19             $scope.hasMore = false;
  20             $scope.imageUpdateSuccess = false;
  21             $scope.imageDeleteSuccess = false;
  22             $scope.uploadedTo = $attrs.uploadedTo;
  23             $scope.view = 'all';
  24
  25             $scope.searching = false;
  26             $scope.searchTerm = '';
  27
  28             let page = 0;
  29             let previousClickTime = 0;
  30             let previousClickImage = 0;
  31             let dataLoaded = false;
  32             let callback = false;
  33
  34             let preSearchImages = [];
  35             let preSearchHasMore = false;
  36
  37             /**
  38              * Used by dropzone to get the endpoint to upload to.
  39              * @returns {string}
  40              */
  41             $scope.getUploadUrl = function () {
  42                 return window.baseUrl('/images/' + $scope.imageType + '/upload');
  43             };
  44
  45             /**
  46              * Cancel the current search operation.
  47              */
  48             function cancelSearch() {
  49                 $scope.searching = false;
  50                 $scope.searchTerm = '';
  51                 $scope.images = preSearchImages;
  52                 $scope.hasMore = preSearchHasMore;
  53             }
  54             $scope.cancelSearch = cancelSearch;
  55
  56
  57             /**
  58              * Runs on image upload, Adds an image to local list of images
  59              * and shows a success message to the user.
  60              * @param file
  61              * @param data
  62              */
  63             $scope.uploadSuccess = function (file, data) {
  64                 $scope.$apply(() => {
  65                     $scope.images.unshift(data);
  66                 });
  67                 events.emit('success', trans('components.image_upload_success'));
  68             };
  69
  70             /**
  71              * Runs the callback and hides the image manager.
  72              * @param returnData
  73              */
  74             function callbackAndHide(returnData) {
  75                 if (callback) callback(returnData);
  76                 $scope.hide();
  77             }
  78
  79             /**
  80              * Image select action. Checks if a double-click was fired.
  81              * @param image
  82              */
  83             $scope.imageSelect = function (image) {
  84                 let dblClickTime = 300;
  85                 let currentTime = Date.now();
  86                 let timeDiff = currentTime - previousClickTime;
  87
  88                 if (timeDiff < dblClickTime && image.id === previousClickImage) {
  89                     // If double click
  90                     callbackAndHide(image);
  91                 } else {
  92                     // If single
  93                     $scope.selectedImage = image;
  94                     $scope.dependantPages = false;
  95                 }
  96                 previousClickTime = currentTime;
  97                 previousClickImage = image.id;
  98             };
  99
 100             /**
 101              * Action that runs when the 'Select image' button is clicked.
 102              * Runs the callback and hides the image manager.
 103              */
 104             $scope.selectButtonClick = function () {
 105                 callbackAndHide($scope.selectedImage);
 106             };
 107
 108             /**
 109              * Show the image manager.
 110              * Takes a callback to execute later on.
 111              * @param doneCallback
 112              */
 113             function show(doneCallback) {
 114                 callback = doneCallback;
 115                 $scope.showing = true;
 116                 $('#image-manager').find('.overlay').css('display', 'flex').hide().fadeIn(240);
 117                 // Get initial images if they have not yet been loaded in.
 118                 if (!dataLoaded) {
 119                     fetchData();
 120                     dataLoaded = true;
 121                 }
 122             }
 123
 124             // Connects up the image manger so it can be used externally
 125             // such as from TinyMCE.
 126             imageManagerService.show = show;
 127             imageManagerService.showExternal = function (doneCallback) {
 128                 $scope.$apply(() => {
 129                     show(doneCallback);
 130                 });
 131             };
 132             window.ImageManager = imageManagerService;
 133
 134             /**
 135              * Hide the image manager
 136              */
 137             $scope.hide = function () {
 138                 $scope.showing = false;
 139                 $('#image-manager').find('.overlay').fadeOut(240);
 140             };
 141
 142             let baseUrl = window.baseUrl('/images/' + $scope.imageType + '/all/');
 143
 144             /**
 145              * Fetch the list image data from the server.
 146              */
 147             function fetchData() {
 148                 let url = baseUrl + page + '?';
 149                 let components = {};
 150                 if ($scope.uploadedTo) components['page_id'] = $scope.uploadedTo;
 151                 if ($scope.searching) components['term'] = $scope.searchTerm;
 152
 153
 154                 url += Object.keys(components).map((key) => {
 155                     return key + '=' + encodeURIComponent(components[key]);
 156                 }).join('&');
 157
 158                 $http.get(url).then((response) => {
 159                     $scope.images = $scope.images.concat(response.data.images);
 160                     $scope.hasMore = response.data.hasMore;
 161                     page++;
 162                 });
 163             }
 164             $scope.fetchData = fetchData;
 165
 166             /**
 167              * Start a search operation
 168              */
 169             $scope.searchImages = function() {
 170
 171                 if ($scope.searchTerm === '') {
 172                     cancelSearch();
 173                     return;
 174                 }
 175
 176                 if (!$scope.searching) {
 177                     preSearchImages = $scope.images;
 178                     preSearchHasMore = $scope.hasMore;
 179                 }
 180
 181                 $scope.searching = true;
 182                 $scope.images = [];
 183                 $scope.hasMore = false;
 184                 page = 0;
 185                 baseUrl = window.baseUrl('/images/' + $scope.imageType + '/search/');
 186                 fetchData();
 187             };
 188
 189             /**
 190              * Set the current image listing view.
 191              * @param viewName
 192              */
 193             $scope.setView = function(viewName) {
 194                 cancelSearch();
 195                 $scope.images = [];
 196                 $scope.hasMore = false;
 197                 page = 0;
 198                 $scope.view = viewName;
 199                 baseUrl = window.baseUrl('/images/' + $scope.imageType  + '/' + viewName + '/');
 200                 fetchData();
 201             };
 202
 203             /**
 204              * Save the details of an image.
 205              * @param event
 206              */
 207             $scope.saveImageDetails = function (event) {
 208                 event.preventDefault();
 209                 let url = window.baseUrl('/images/update/' + $scope.selectedImage.id);
 210                 $http.put(url, this.selectedImage).then(response => {
 211                     events.emit('success', trans('components.image_update_success'));
 212                 }, (response) => {
 213                     if (response.status === 422) {
 214                         let errors = response.data;
 215                         let message = '';
 216                         Object.keys(errors).forEach((key) => {
 217                             message += errors[key].join('\n');
 218                         });
 219                         events.emit('error', message);
 220                     } else if (response.status === 403) {
 221                         events.emit('error', response.data.error);
 222                     }
 223                 });
 224             };
 225
 226             /**
 227              * Delete an image from system and notify of success.
 228              * Checks if it should force delete when an image
 229              * has dependant pages.
 230              * @param event
 231              */
 232             $scope.deleteImage = function (event) {
 233                 event.preventDefault();
 234                 let force = $scope.dependantPages !== false;
 235                 let url = window.baseUrl('/images/' + $scope.selectedImage.id);
 236                 if (force) url += '?force=true';
 237                 $http.delete(url).then((response) => {
 238                     $scope.images.splice($scope.images.indexOf($scope.selectedImage), 1);
 239                     $scope.selectedImage = false;
 240                     events.emit('success', trans('components.image_delete_success'));
 241                 }, (response) => {
 242                     // Pages failure
 243                     if (response.status === 400) {
 244                         $scope.dependantPages = response.data;
 245                     } else if (response.status === 403) {
 246                         events.emit('error', response.data.error);
 247                     }
 248                 });
 249             };
 250
 251             /**
 252              * Simple date creator used to properly format dates.
 253              * @param stringDate
 254              * @returns {Date}
 255              */
 256             $scope.getDate = function (stringDate) {
 257                 return new Date(stringDate);
 258             };
 259
 260         }]);
 261
 262     ngApp.controller('PageEditController', ['$scope', '$http', '$attrs', '$interval', '$timeout', '$sce',
 263         function ($scope, $http, $attrs, $interval, $timeout, $sce) {
 264
 265         $scope.editorOptions = editorOptions();
 266         $scope.editContent = '';
 267         $scope.draftText = '';
 268         let pageId = Number($attrs.pageId);
 269         let isEdit = pageId !== 0;
 270         let autosaveFrequency = 30; // AutoSave interval in seconds.
 271         let isMarkdown = $attrs.editorType === 'markdown';
 272         $scope.draftsEnabled = $attrs.draftsEnabled === 'true';
 273         $scope.isUpdateDraft = Number($attrs.pageUpdateDraft) === 1;
 274         $scope.isNewPageDraft = Number($attrs.pageNewDraft) === 1;
 275
 276         // Set initial header draft text
 277         if ($scope.isUpdateDraft || $scope.isNewPageDraft) {
 278             $scope.draftText = trans('entities.pages_editing_draft');
 279         } else {
 280             $scope.draftText = trans('entities.pages_editing_page');
 281         }
 282
 283         let autoSave = false;
 284
 285         let currentContent = {
 286             title: false,
 287             html: false
 288         };
 289
 290         if (isEdit && $scope.draftsEnabled) {
 291             setTimeout(() => {
 292                 startAutoSave();
 293             }, 1000);
 294         }
 295
 296         // Actions specifically for the markdown editor
 297         if (isMarkdown) {
 298             $scope.displayContent = '';
 299             // Editor change event
 300             $scope.editorChange = function (content) {
 301                 $scope.displayContent = $sce.trustAsHtml(content);
 302             }
 303         }
 304
 305         if (!isMarkdown) {
 306             $scope.editorChange = function() {};
 307         }
 308
 309         let lastSave = 0;
 310
 311         /**
 312          * Start the AutoSave loop, Checks for content change
 313          * before performing the costly AJAX request.
 314          */
 315         function startAutoSave() {
 316             currentContent.title = $('#name').val();
 317             currentContent.html = $scope.editContent;
 318
 319             autoSave = $interval(() => {
 320                 // Return if manually saved recently to prevent bombarding the server
 321                 if (Date.now() - lastSave < (1000*autosaveFrequency)/2) return;
 322                 let newTitle = $('#name').val();
 323                 let newHtml = $scope.editContent;
 324
 325                 if (newTitle !== currentContent.title || newHtml !== currentContent.html) {
 326                     currentContent.html = newHtml;
 327                     currentContent.title = newTitle;
 328                     saveDraft();
 329                 }
 330
 331             }, 1000 * autosaveFrequency);
 332         }
 333
 334         let draftErroring = false;
 335         /**
 336          * Save a draft update into the system via an AJAX request.
 337          */
 338         function saveDraft() {
 339             if (!$scope.draftsEnabled) return;
 340             let data = {
 341                 name: $('#name').val(),
 342                 html: isMarkdown ? $sce.getTrustedHtml($scope.displayContent) : $scope.editContent
 343             };
 344
 345             if (isMarkdown) data.markdown = $scope.editContent;
 346
 347             let url = window.baseUrl('/ajax/page/' + pageId + '/save-draft');
 348             $http.put(url, data).then(responseData => {
 349                 draftErroring = false;
 350                 let updateTime = moment.utc(moment.unix(responseData.data.timestamp)).toDate();
 351                 $scope.draftText = responseData.data.message + moment(updateTime).format('HH:mm');
 352                 if (!$scope.isNewPageDraft) $scope.isUpdateDraft = true;
 353                 showDraftSaveNotification();
 354                 lastSave = Date.now();
 355             }, errorRes => {
 356                 if (draftErroring) return;
 357                 events.emit('error', trans('errors.page_draft_autosave_fail'));
 358                 draftErroring = true;
 359             });
 360         }
 361
 362         function showDraftSaveNotification() {
 363             $scope.draftUpdated = true;
 364             $timeout(() => {
 365                 $scope.draftUpdated = false;
 366             }, 2000)
 367         }
 368
 369         $scope.forceDraftSave = function() {
 370             saveDraft();
 371         };
 372
 373         // Listen to shortcuts coming via events
 374         $scope.$on('editor-keydown', (event, data) => {
 375             // Save shortcut (ctrl+s)
 376             if (data.keyCode == 83 && (navigator.platform.match("Mac") ? data.metaKey : data.ctrlKey)) {
 377                 data.preventDefault();
 378                 saveDraft();
 379             }
 380         });
 381
 382         /**
 383          * Discard the current draft and grab the current page
 384          * content from the system via an AJAX request.
 385          */
 386         $scope.discardDraft = function () {
 387             let url = window.baseUrl('/ajax/page/' + pageId);
 388             $http.get(url).then((responseData) => {
 389                 if (autoSave) $interval.cancel(autoSave);
 390                 $scope.draftText = trans('entities.pages_editing_page');
 391                 $scope.isUpdateDraft = false;
 392                 $scope.$broadcast('html-update', responseData.data.html);
 393                 $scope.$broadcast('markdown-update', responseData.data.markdown || responseData.data.html);
 394                 $('#name').val(responseData.data.name);
 395                 $timeout(() => {
 396                     startAutoSave();
 397                 }, 1000);
 398                 events.emit('success', trans('entities.pages_draft_discarded'));
 399             });
 400         };
 401
 402     }]);
 403
 404     ngApp.controller('PageTagController', ['$scope', '$http', '$attrs',
 405         function ($scope, $http, $attrs) {
 406
 407             const pageId = Number($attrs.pageId);
 408             $scope.tags = [];
 409
 410             $scope.sortOptions = {
 411                 handle: '.handle',
 412                 items: '> tr',
 413                 containment: "parent",
 414                 axis: "y"
 415             };
 416
 417             /**
 418              * Push an empty tag to the end of the scope tags.
 419              */
 420             function addEmptyTag() {
 421                 $scope.tags.push({
 422                     name: '',
 423                     value: ''
 424                 });
 425             }
 426             $scope.addEmptyTag = addEmptyTag;
 427
 428             /**
 429              * Get all tags for the current book and add into scope.
 430              */
 431             function getTags() {
 432                 let url = window.baseUrl(`/ajax/tags/get/page/${pageId}`);
 433                 $http.get(url).then((responseData) => {
 434                     $scope.tags = responseData.data;
 435                     addEmptyTag();
 436                 });
 437             }
 438             getTags();
 439
 440             /**
 441              * Set the order property on all tags.
 442              */
 443             function setTagOrder() {
 444                 for (let i = 0; i < $scope.tags.length; i++) {
 445                     $scope.tags[i].order = i;
 446                 }
 447             }
 448
 449             /**
 450              * When an tag changes check if another empty editable
 451              * field needs to be added onto the end.
 452              * @param tag
 453              */
 454             $scope.tagChange = function(tag) {
 455                 let cPos = $scope.tags.indexOf(tag);
 456                 if (cPos !== $scope.tags.length-1) return;
 457
 458                 if (tag.name !== '' || tag.value !== '') {
 459                     addEmptyTag();
 460                 }
 461             };
 462
 463             /**
 464              * When an tag field loses focus check the tag to see if its
 465              * empty and therefore could be removed from the list.
 466              * @param tag
 467              */
 468             $scope.tagBlur = function(tag) {
 469                 let isLast = $scope.tags.length - 1 === $scope.tags.indexOf(tag);
 470                 if (tag.name === '' && tag.value === '' && !isLast) {
 471                     let cPos = $scope.tags.indexOf(tag);
 472                     $scope.tags.splice(cPos, 1);
 473                 }
 474             };
 475
 476             /**
 477              * Remove a tag from the current list.
 478              * @param tag
 479              */
 480             $scope.removeTag = function(tag) {
 481                 let cIndex = $scope.tags.indexOf(tag);
 482                 $scope.tags.splice(cIndex, 1);
 483             };
 484
 485         }]);
 486
 487
 488     ngApp.controller('PageAttachmentController', ['$scope', '$http', '$attrs',
 489         function ($scope, $http, $attrs) {
 490
 491             const pageId = $scope.uploadedTo = $attrs.pageId;
 492             let currentOrder = '';
 493             $scope.files = [];
 494             $scope.editFile = false;
 495             $scope.file = getCleanFile();
 496             $scope.errors = {
 497                 link: {},
 498                 edit: {}
 499             };
 500
 501             function getCleanFile() {
 502                 return {
 503                     page_id: pageId
 504                 };
 505             }
 506
 507             // Angular-UI-Sort options
 508             $scope.sortOptions = {
 509                 handle: '.handle',
 510                 items: '> tr',
 511                 containment: "parent",
 512                 axis: "y",
 513                 stop: sortUpdate,
 514             };
 515
 516             /**
 517              * Event listener for sort changes.
 518              * Updates the file ordering on the server.
 519              * @param event
 520              * @param ui
 521              */
 522             function sortUpdate(event, ui) {
 523                 let newOrder = $scope.files.map(file => {return file.id}).join(':');
 524                 if (newOrder === currentOrder) return;
 525
 526                 currentOrder = newOrder;
 527                 $http.put(window.baseUrl(`/attachments/sort/page/${pageId}`), {files: $scope.files}).then(resp => {
 528                     events.emit('success', resp.data.message);
 529                 }, checkError('sort'));
 530             }
 531
 532             /**
 533              * Used by dropzone to get the endpoint to upload to.
 534              * @returns {string}
 535              */
 536             $scope.getUploadUrl = function (file) {
 537                 let suffix = (typeof file !== 'undefined') ? `/${file.id}` : '';
 538                 return window.baseUrl(`/attachments/upload${suffix}`);
 539             };
 540
 541             /**
 542              * Get files for the current page from the server.
 543              */
 544             function getFiles() {
 545                 let url = window.baseUrl(`/attachments/get/page/${pageId}`);
 546                 $http.get(url).then(resp => {
 547                     $scope.files = resp.data;
 548                     currentOrder = resp.data.map(file => {return file.id}).join(':');
 549                 }, checkError('get'));
 550             }
 551             getFiles();
 552
 553             /**
 554              * Runs on file upload, Adds an file to local file list
 555              * and shows a success message to the user.
 556              * @param file
 557              * @param data
 558              */
 559             $scope.uploadSuccess = function (file, data) {
 560                 $scope.$apply(() => {
 561                     $scope.files.push(data);
 562                 });
 563                 events.emit('success', trans('entities.attachments_file_uploaded'));
 564             };
 565
 566             /**
 567              * Upload and overwrite an existing file.
 568              * @param file
 569              * @param data
 570              */
 571             $scope.uploadSuccessUpdate = function (file, data) {
 572                 $scope.$apply(() => {
 573                     let search = filesIndexOf(data);
 574                     if (search !== -1) $scope.files[search] = data;
 575
 576                     if ($scope.editFile) {
 577                         $scope.editFile = angular.copy(data);
 578                         data.link = '';
 579                     }
 580                 });
 581                 events.emit('success', trans('entities.attachments_file_updated'));
 582             };
 583
 584             /**
 585              * Delete a file from the server and, on success, the local listing.
 586              * @param file
 587              */
 588             $scope.deleteFile = function(file) {
 589                 if (!file.deleting) {
 590                     file.deleting = true;
 591                     return;
 592                 }
 593                   $http.delete(window.baseUrl(`/attachments/${file.id}`)).then(resp => {
 594                       events.emit('success', resp.data.message);
 595                       $scope.files.splice($scope.files.indexOf(file), 1);
 596                   }, checkError('delete'));
 597             };
 598
 599             /**
 600              * Attach a link to a page.
 601              * @param file
 602              */
 603             $scope.attachLinkSubmit = function(file) {
 604                 file.uploaded_to = pageId;
 605                 $http.post(window.baseUrl('/attachments/link'), file).then(resp => {
 606                     $scope.files.push(resp.data);
 607                     events.emit('success', trans('entities.attachments_link_attached'));
 608                     $scope.file = getCleanFile();
 609                 }, checkError('link'));
 610             };
 611
 612             /**
 613              * Start the edit mode for a file.
 614              * @param file
 615              */
 616             $scope.startEdit = function(file) {
 617                 $scope.editFile = angular.copy(file);
 618                 $scope.editFile.link = (file.external) ? file.path : '';
 619             };
 620
 621             /**
 622              * Cancel edit mode
 623              */
 624             $scope.cancelEdit = function() {
 625                 $scope.editFile = false;
 626             };
 627
 628             /**
 629              * Update the name and link of a file.
 630              * @param file
 631              */
 632             $scope.updateFile = function(file) {
 633                 $http.put(window.baseUrl(`/attachments/${file.id}`), file).then(resp => {
 634                     let search = filesIndexOf(resp.data);
 635                     if (search !== -1) $scope.files[search] = resp.data;
 636
 637                     if ($scope.editFile && !file.external) {
 638                         $scope.editFile.link = '';
 639                     }
 640                     $scope.editFile = false;
 641                     events.emit('success', trans('entities.attachments_updated_success'));
 642                 }, checkError('edit'));
 643             };
 644
 645             /**
 646              * Get the url of a file.
 647              */
 648             $scope.getFileUrl = function(file) {
 649                 return window.baseUrl('/attachments/' + file.id);
 650             };
 651
 652             /**
 653              * Search the local files via another file object.
 654              * Used to search via object copies.
 655              * @param file
 656              * @returns int
 657              */
 658             function filesIndexOf(file) {
 659                 for (let i = 0; i < $scope.files.length; i++) {
 660                     if ($scope.files[i].id == file.id) return i;
 661                 }
 662                 return -1;
 663             }
 664
 665             /**
 666              * Check for an error response in a ajax request.
 667              * @param errorGroupName
 668              */
 669             function checkError(errorGroupName) {
 670                 $scope.errors[errorGroupName] = {};
 671                 return function(response) {
 672                     if (typeof response.data !== 'undefined' && typeof response.data.error !== 'undefined') {
 673                         events.emit('error', response.data.error);
 674                     }
 675                     if (typeof response.data !== 'undefined' && typeof response.data.validation !== 'undefined') {
 676                         $scope.errors[errorGroupName] = response.data.validation;
 677                         console.log($scope.errors[errorGroupName])
 678                     }
 679                 }
 680             }
 681
 682         }]);
 683
 684 };