PageTree.ts 16.4 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */

import * as d3selection from 'd3-selection';
import AjaxRequest from 'TYPO3/CMS/Core/Ajax/AjaxRequest';
import {SvgTree, SvgTreeSettings, TreeNodeSelection} from '../SvgTree';
import {TreeNode} from '../Tree/TreeNode';
18
import {PageTreeDragDrop, PageTreeNodeDragHandler} from './PageTreeDragDrop';
19
20
21
22
import Icons = require('../Icons');
import ContextMenu = require('../ContextMenu');
import Persistent from '../Storage/Persistent';
import {AjaxResponse} from 'TYPO3/CMS/Core/Ajax/AjaxResponse';
Benni Mack's avatar
Benni Mack committed
23
import {KeyTypesEnum as KeyTypes} from '../Enum/KeyTypes';
24
25
26
27
28

interface PageTreeSettings extends SvgTreeSettings {
  temporaryMountPoint?: string;
}

29
30
31
32
/**
 * A Tree based on SVG for pages, which has a AJAX-based loading of the tree
 * and also handles search + filter via AJAX.
 */
33
export class PageTree extends SvgTree
34
{
35
  public nodeIsEdit: boolean;
36
  public settings: PageTreeSettings;
Benni Mack's avatar
Benni Mack committed
37
38
  protected networkErrorTitle: string = TYPO3.lang.pagetree_networkErrorTitle;
  protected networkErrorMessage: string = TYPO3.lang.pagetree_networkErrorDesc;
39
  protected searchQuery: string = '';
40
41
  private originalNodes: string = '';
  private dragDrop: PageTreeDragDrop;
42

43
44
45
46
47
  public constructor() {
    super();
    this.settings.defaultProperties = {
      hasChildren: false,
      nameSourceField: 'title',
Benni Mack's avatar
Benni Mack committed
48
      itemType: 'pages',
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
      prefix: '',
      suffix: '',
      locked: false,
      loaded: false,
      overlayIcon: '',
      selectable: true,
      expanded: false,
      checked: false,
      backgroundColor: '',
      stopPageTree: false,
      class: '',
      readableRootline: '',
      isMountPoint: false,
    };
  }

  public initialize(selector: HTMLElement, settings: any, dragDrop?: PageTreeDragDrop): boolean {
    if (!super.initialize(selector, settings)) {
      return false;
    }

    this.dispatch.on('nodeSelectedAfter.pageTree', (node: TreeNode) => this.nodeSelectedAfter(node));
    this.dispatch.on('nodeRightClick.pageTree', (node: TreeNode) => this.nodeRightClick(node));
    this.dispatch.on('prepareLoadedNode.pageTree', (node: TreeNode) => this.prepareLoadedNode(node));
    this.dragDrop = dragDrop;

    if (this.settings.temporaryMountPoint) {
      this.addMountPoint(this.settings.temporaryMountPoint);
    }
    return true;
79
  }
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101

  public sendChangeCommand(data: any): void {
    let params = '';
    let targetUid = 0;

    if (data.target) {
      targetUid = data.target.identifier;
      if (data.position === 'after') {
        targetUid = -targetUid;
      }
    }

    if (data.command === 'new') {
      params = '&data[pages][NEW_1][pid]=' + targetUid +
        '&data[pages][NEW_1][title]=' + encodeURIComponent(data.name) +
        '&data[pages][NEW_1][doktype]=' + data.type;

    } else if (data.command === 'edit') {
      params = '&data[pages][' + data.uid + '][' + data.nameSourceField + ']=' + encodeURIComponent(data.title);
    } else {
      if (data.command === 'delete') {
        if (data.uid === window.fsMod.recentIds.web) {
102
          this.selectNode(this.nodes[0]);
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
        }
        params = '&cmd[pages][' + data.uid + '][delete]=1';
      } else {
        params = 'cmd[pages][' + data.uid + '][' + data.command + ']=' + targetUid;
      }
    }

    this.nodesAddPlaceholder();

    (new AjaxRequest(top.TYPO3.settings.ajaxUrls.record_process))
      .post(params, {
        headers: { 'Content-Type': 'application/x-www-form-urlencoded', 'X-Requested-With': 'XMLHttpRequest'},
      })
      .then((response) => {
        return response.resolve();
      })
      .then((response) => {
        if (response && response.hasErrors) {
Benni Mack's avatar
Benni Mack committed
121
          this.errorNotification(response.messages, false);
122
123
124
125
126
127
128
129
130
131
132
133
134
          this.nodesContainer.selectAll('.node').remove();
          this.update();
          this.nodesRemovePlaceholder();
        } else {
          this.refreshOrFilterTree();
        }
      })
      .catch((error) => {
        this.errorNotification(error);
      });
  }

  public nodeRightClick(node: TreeNode): void {
Benni Mack's avatar
Benni Mack committed
135
136
137
138
139
140
141
142
    ContextMenu.show(
      node.itemType,
      parseInt(node.identifier, 10),
      'tree',
      '',
      '',
      this.getNodeElement(node)
    );
143
  }
144
145
146
147
148
149

  /**
   * Event listener called for each loaded node,
   * here used to mark node remembered in fsMode as selected
   */
  public prepareLoadedNode(node: TreeNode) {
150
    if (node.stateIdentifier === top.window.fsMod.navFrameHighlightedID.web) {
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
      node.checked = true;
    }
  }

  public hideChildren(node: TreeNode) {
    super.hideChildren(node);
    Persistent.set('BackendComponents.States.Pagetree.stateHash.' + node.stateIdentifier, '0');
  }

  public showChildren(node: TreeNode) {
    this.loadChildrenOfNode(node);
    super.showChildren(node);
    Persistent.set('BackendComponents.States.Pagetree.stateHash.' + node.stateIdentifier, '1');
  }
  public updateNodeBgClass(nodeBg: TreeNodeSelection) {
    return super.updateNodeBgClass.call(this, nodeBg).call(this.initializeDragForNode());
167
  }
168
169

  public nodesUpdate(nodes: TreeNodeSelection) {
Benni Mack's avatar
Benni Mack committed
170
    nodes = super.nodesUpdate.call(this, nodes).call(this.initializeDragForNode());
171
172
173
174
175
176
177
178
179
180
    nodes
      .append('text')
      .text('+')
      .attr('class', 'node-stop')
      .attr('dx', 30)
      .attr('dy', 5)
      .attr('visibility', (node: TreeNode) => node.stopPageTree && node.depth !== 0 ? 'visible' : 'hidden')
      .on('click', (evt: MouseEvent, node: TreeNode) => this.setTemporaryMountPoint(parseInt(node.identifier, 10)));

    return nodes;
181
  }
182
183
184
185
186
187
188
189
190
191
192

  /**
   * Node selection logic (triggered by different events)
   * Page tree supports only one node to be selected at a time
   * so the default function from SvgTree needs to be overridden
   */
  public selectNode(node: TreeNode) {
    if (!this.isNodeSelectable(node)) {
      return;
    }
    // Disable already selected nodes
193
    this.disableSelectedNodes();
194
195
196
    node.checked = true;
    this.dispatch.call('nodeSelectedAfter', this, node);
    this.update();
197
  }
198

199
200
201
202
  public refreshOrFilterTree(searchQuery?: string|null): void {
    if (typeof searchQuery === 'string') {
      this.searchQuery = searchQuery;
    }
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
    if (this.searchQuery !== '') {
      this.filterTree();
    } else {
      this.refreshTree();
    }
  }

  public resetFilter(): void {
    this.searchQuery = '';
    if (this.originalNodes.length > 0) {
      let currentlySelected = this.getSelectedNodes()[0];
      if (typeof currentlySelected === 'undefined') {
        this.refreshTree();
        return;
      }
      this.nodes = JSON.parse(this.originalNodes);
      this.originalNodes = '';
220
221
222
223
      // re-select the node from the identifier because the nodes have been updated
      const currentlySelectedNode = this.nodes.find((node: TreeNode) => {
        return node.stateIdentifier === currentlySelected.stateIdentifier;
      });
224
225
226
227
228
229
230
231
      if (currentlySelectedNode) {
        this.selectNode(currentlySelectedNode);
      } else {
        this.refreshTree();
      }
    } else {
      this.refreshTree();
    }
232
233
234
235
236
237
238
239
240
241
242
243
    this.prepareDataForVisibleNodes();
    this.update();
  }

  /**
   * Make the DOM element of the node given as parameter focusable and focus it
   */
  public switchFocusNode(node: TreeNode) {
    // Focus node only if it's not currently in edit mode
    if (!this.nodeIsEdit) {
      this.switchFocus(this.getNodeElement(node));
    }
244
245
246
247
248
249
250
251
252
253
254
255
256
257
  }

  public setTemporaryMountPoint(pid: number): void {
    const params = 'pid=' + pid;

    (new AjaxRequest(top.TYPO3.settings.ajaxUrls.page_tree_set_temporary_mount_point))
      .post(params, {
        headers: { 'Content-Type': 'application/x-www-form-urlencoded', 'X-Requested-With': 'XMLHttpRequest'},
      })
      .then((response) => {
        return response.resolve();
      })
      .then((response) => {
        if (response && response.hasErrors) {
Benni Mack's avatar
Benni Mack committed
258
          this.errorNotification(response.message, true);
259
260
261
262
263
264
265
          this.update();
        } else {
          this.addMountPoint(response.mountPointPath);
          this.refreshOrFilterTree();
        }
      })
      .catch((error) => {
Benni Mack's avatar
Benni Mack committed
266
        this.errorNotification(error, true);
267
268
269
270
271
272
273
      });
  }

  public unsetTemporaryMountPoint() {
    Persistent.unset('pageTree_temporaryMountPoint').then(() => {
      this.refreshTree();
    });
274
  }
275
276
277
278
279
280
281
282

  /**
   * Initializes a drag&drop when called on the page tree. Should be moved somewhere else at some point
   */
  public initializeDragForNode() {
    return this.dragDrop.connectDragHandler(new PageTreeNodeDragHandler(this, this.dragDrop))
  }

283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
  public removeEditedText() {
    const inputWrapper = d3selection.selectAll('.node-edit');
    if (inputWrapper.size()) {
      try {
        inputWrapper.remove();
        this.nodeIsEdit = false;
      } catch (e) {
        // ...
      }
    }
  }

  protected filterTree() {
    this.nodesAddPlaceholder();
    (new AjaxRequest(this.settings.filterUrl + '&q=' + this.searchQuery))
      .get({cache: 'no-cache'})
      .then((response: AjaxResponse) => response.resolve())
      .then((json) => {
        let nodes = Array.isArray(json) ? json : [];
        if (nodes.length > 0) {
          if (this.originalNodes === '') {
            this.originalNodes = JSON.stringify(this.nodes);
          }
          this.replaceData(nodes);
        }
        this.nodesRemovePlaceholder();
      })
      .catch((error: any) => {
        this.errorNotification(error, false)
        this.nodesRemovePlaceholder();
        throw error;
      });
  }

  /**
   * Loads child nodes via Ajax (used when expanding a collapsed node)
   *
   * @param parentNode
   * @return {boolean}
   */
  protected loadChildrenOfNode(parentNode: TreeNode) {
    if (parentNode.loaded) {
      return;
    }

    this.nodesAddPlaceholder();
    (new AjaxRequest(this.settings.dataUrl + '&pid=' + parentNode.identifier + '&mount=' + parentNode.mountPoint + '&pidDepth=' + parentNode.depth))
      .get({cache: 'no-cache'})
      .then((response: AjaxResponse) => response.resolve())
      .then((json: any) => {
        let nodes = Array.isArray(json) ? json : [];
        // first element is a parent
        nodes.shift();
        const index = this.nodes.indexOf(parentNode) + 1;
        // adding fetched node after parent
        nodes.forEach((node: TreeNode, offset: number) => {
          this.nodes.splice(index + offset, 0, node);
        });

        parentNode.loaded = true;
        this.setParametersNode();
        this.prepareDataForVisibleNodes();
        this.update();
        this.nodesRemovePlaceholder();

        this.switchFocusNode(parentNode);
      })
      .catch((error: any) => {
        this.errorNotification(error, false)
        this.nodesRemovePlaceholder();
        throw error;
      });
  }


  /**
   * Observer for the selectedNode event
   */
  protected nodeSelectedAfter(node: TreeNode) {
    if (!node.checked) {
      return;
    }
    //remember the selected page in the global state
    top.window.fsMod.recentIds.web = node.identifier;
    top.window.fsMod.currentBank = node.stateIdentifier.split('_')[0];
    top.window.fsMod.navFrameHighlightedID.web = node.stateIdentifier;

    let separator = '?';
    if (top.window.currentSubScript.indexOf('?') !== -1) {
      separator = '&';
    }

    top.TYPO3.Backend.ContentContainer.setUrl(
      top.window.currentSubScript + separator + 'id=' + node.identifier
    );
  }

380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
  /**
   * Event handler for double click on a node's label
   * Changed text position if there is 'stop page tree' option
   */
  protected appendTextElement(nodes: TreeNodeSelection): TreeNodeSelection {
    let clicks = 0;
    return super.appendTextElement(nodes)
      .attr('dx', (node) => {
        let position = this.textPosition;
        if (node.stopPageTree && node.depth !== 0) {
          position += 15;
        }
        if (node.locked) {
          position += 15;
        }
        return position;
      })
      .on('click', (event, node: TreeNode) => {
        if (node.identifier === '0') {
399
          this.selectNode(node);
400
401
402
403
404
          return;
        }
        if (++clicks === 1) {
          setTimeout(() => {
            if (clicks === 1) {
405
              this.selectNode(node);
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
            } else {
              this.editNodeLabel(node);
            }
            clicks = 0;
          }, 300);
        }
      });
  };

  private sendEditNodeLabelCommand(node: TreeNode) {
    const params = '&data[pages][' + node.identifier + '][' + node.nameSourceField + ']=' + encodeURIComponent(node.newName);

    // remove old node from svg tree
    this.nodesAddPlaceholder(node);

    (new AjaxRequest(top.TYPO3.settings.ajaxUrls.record_process))
      .post(params, {
        headers: { 'Content-Type': 'application/x-www-form-urlencoded', 'X-Requested-With': 'XMLHttpRequest'},
      })
      .then((response) => {
        return response.resolve();
      })
      .then((response) => {
        if (response && response.hasErrors) {
Benni Mack's avatar
Benni Mack committed
430
          this.errorNotification(response.messages, false);
431
432
433
        } else {
          node.name = node.newName;
        }
Benni Mack's avatar
Benni Mack committed
434
        this.refreshOrFilterTree();
435
436
      })
      .catch((error) => {
Benni Mack's avatar
Benni Mack committed
437
        this.errorNotification(error, true);
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
      });
  }

  private editNodeLabel(node: TreeNode) {
    if (!node.allowEdit) {
      return;
    }
    this.removeEditedText();
    this.nodeIsEdit = true;

    d3selection.select(this.svg.node().parentNode as HTMLElement)
      .append('input')
      .attr('class', 'node-edit')
      .style('top', () => {
        const top = node.y + this.settings.marginTop;
        return top + 'px';
      })
      .style('left', (node.x + this.textPosition + 5) + 'px')
      .style('width', this.settings.width - (node.x + this.textPosition + 20) + 'px')
      .style('height', this.settings.nodeHeight + 'px')
      .attr('type', 'text')
      .attr('value', node.name)
Benni Mack's avatar
Benni Mack committed
460
      .on('keydown', (event: KeyboardEvent) => {
461
462
        // @todo Migrate to `evt.code`, see https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/code
        const code = event.keyCode;
Benni Mack's avatar
Benni Mack committed
463
464
465
466
467
468

        if (code === KeyTypes.ENTER || code === KeyTypes.TAB) {
          const target = event.target as HTMLInputElement;
          const newName = target.value.trim();
          this.nodeIsEdit = false;
          this.removeEditedText();
469
470
471
          if (newName.length && (newName !== node.name)) {
            node.nameSourceField = node.nameSourceField || 'title';
            node.newName = newName;
Benni Mack's avatar
Benni Mack committed
472
            this.sendEditNodeLabelCommand(node);
473
          }
Benni Mack's avatar
Benni Mack committed
474
475
476
        } else if (code === KeyTypes.ESCAPE) {
          this.nodeIsEdit = false;
          this.removeEditedText();
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
        }
      })
      .on('blur', (evt: FocusEvent) => {
        if (!this.nodeIsEdit) {
          return;
        }
        const target = evt.target as HTMLInputElement;
        const newName = target.value.trim();
        if (newName.length && (newName !== node.name)) {
          node.nameSourceField = node.nameSourceField || 'title';
          node.newName = newName;
          this.sendEditNodeLabelCommand(node);
        }
        this.removeEditedText();
      })
      .node()
      .select();
  }

  private addMountPoint(breadcrumb: string) {
    let existingMountPointInfo = this.wrapper.parentNode.querySelector('.node-mount-point');
    if (existingMountPointInfo) {
      existingMountPointInfo.parentNode.removeChild(existingMountPointInfo);
    }

    this.wrapper.insertAdjacentHTML('beforebegin',
      '<div class="node-mount-point">' +
      '<div class="node-mount-point__icon" data-tree-icon="actions-document-info"></div>' +
      '<div class="node-mount-point__text"><div>' + breadcrumb + '</div></div>' +
      '<div class="node-mount-point__icon" data-tree-icon="actions-close" title="' + TYPO3.lang['labels.temporaryDBmount'] + '"></div>' +
      '</div>'
    );

    this.wrapper.parentNode
      .querySelector('[data-tree-icon=actions-close]')
      .addEventListener('click', () => {
        this.unsetTemporaryMountPoint();
        this.wrapper.parentNode.querySelector('.node-mount-point').remove();
      });

    // get icons
    this.wrapper.parentNode.querySelectorAll('.node-mount-point [data-tree-icon]').forEach((iconElement: HTMLElement) => {
      Icons.getIcon(iconElement.dataset.treeIcon, Icons.sizes.small, null, null, 'inline' as any).then((icon: string) => {
        iconElement.insertAdjacentHTML('beforeend', icon);
      });
    });
523
  }
524
}