App.vue 11.8 KB
Newer Older
Mathias Goebel's avatar
Mathias Goebel committed
1
<template>
2
3
  <q-layout
    id="q-app"
4
    class="root viewport"
5
6
    view="hHh Lpr fFf"
  >
7
8
9
10
11
12
13
14
15
    <Header
      v-if="config.headers.all"
      :collectiontitle="collectiontitle"
      :config="config"
      :imageurl="imageurl"
      :item="item"
      :itemurls="itemurls"
      :manifests="manifests"
      :panels="panels"
16
17
      :projectcolors="config.colors"
      :standalone="config.standalone"
18
    />
19

20
21
    <q-page-container class="root">
      <router-view
22
        :annotations="annotations"
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
        :collection="collection"
        :config="config"
        :contenttypes="contentTypes"
        :contenturls="contenturls"
        :fontsize="fontsize"
        :imageurl="imageurl"
        :item="item"
        :labels="config.labels"
        :manifests="manifests"
        :panels="panels"
        :request="request"
        :tree="tree"
      />
    </q-page-container>
  </q-layout>
Mathias Goebel's avatar
Mathias Goebel committed
38
39
40
</template>

<script>
schneider210's avatar
schneider210 committed
41
import { colors } from 'quasar';
42
import Header from '@/components/header.vue';
43
import Panels from '@/mixins/panels';
44

Mathias Goebel's avatar
Mathias Goebel committed
45
export default {
46
  name: 'TIDO',
47
48
49
  components: {
    Header,
  },
50
  mixins: [Panels],
51
52
  data() {
    return {
53
      annotations: [],
54
      collection: {},
55
      collectiontitle: '',
56
      config: {},
57
      contentTypes: [],
58
      contenturls: [],
schneider210's avatar
schneider210 committed
59
      fontsize: 14,
60
      imageurl: '',
61
      isCollection: false,
62
      item: {},
63
64
65
66
67
68
      itemurl: '',
      itemurls: [],
      manifests: [],
      tree: [],
    };
  },
nwindis's avatar
nwindis committed
69
70
71
72
73
  created() {
    this.getConfig();
    this.init();
    this.itemurls.sort((a, b) => a.localeCompare(b, undefined, { numeric: true }));

schneider210's avatar
schneider210 committed
74
75
    this.$q.dark.set('auto');

nwindis's avatar
nwindis committed
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
    if (this.config.colors.primary && this.config.colors.secondary && this.config.colors.accent) {
      colors.setBrand('primary', this.config.colors.primary);
      colors.setBrand('secondary', this.config.colors.secondary);
      colors.setBrand('accent', this.config.colors.accent);
    }
  },
  mounted() {
    /**
      * listen to fontsize change (user interaction). emitted in @/components/content.vue
      * in- or rather decrease fontsize of the text by 1px
      * default fontsize: 14px
      *
      * @param number fontsize
      */
    this.$root.$on('update-fontsize', (fontsize) => {
      this.fontsize = fontsize;
    });
    this.$root.$on('panels-position', (newPanels) => {
      this.panels = newPanels;
    });
    /**
      * listen to item change (user interaction).
      * emitted in: *getItemurls*; handler for tree nodes. fired on user interaction
      *
      * @param string url
      */
    this.$root.$on('update-item', (url) => {
      this.itemurl = url;
      this.$router.push({ query: { itemurl: url } });
      // NOTE: Set imageurl to an empty string. Otherwise, if there is no corresponding image,
      // the "preceding" image according to the "preceding" item will be shown.
      this.imageurl = '';
      this.getItemData(url);
    });
  },
111
  methods: {
schneider210's avatar
schneider210 committed
112
113
114
115
116
117
118
119
120
121
    /**
      * get resources using JavaScript's native fetch api
      * caller: *getCollection()*, *getItemData()*, *getManifest()*
      *         *@/components/content.vue::getSupport()*, *@/components/content.vue::created-hook*
      *
      * @param string url
      * @param string responsetype
      *
      * @return promise data
      */
122
123
124
125
126
127
    async request(url, responsetype = 'json') {
      const response = await fetch(url);
      const data = await (responsetype === 'text' ? response.text() : response.json());

      return data;
    },
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
    /**
    * filter the annotation IDs and the matching text part of the current item
    *
    * caller: *getAnnotations()*
    *
    * @param array annotations
    *
    * @return array identifiers
    */
    filterAnnotations(annotations) {
      const identifiers = [];

      annotations.forEach((annotation) => {
        const id = this.getAnnotationId(annotation);
        const text = this.getAnnotationText(id);

        identifiers.push({
          id,
          contenttype: annotation.body['x-content-type'],
          description: annotation.body.value,
          selected: this.config.annotations.show,
          text,
        });
      });

      return identifiers;
    },

    /**
    * get the annotation id/s of the current item
    *
    * caller: *filterAnnotations()*
    *
    * @param object annotation
    *
    * @return string
    */
    getAnnotationId(annotation) {
      const split = annotation.target.id.split('/');

      return split[split.length - 1];
    },
    /**
      * match annotation against it's text counterpart
      * caller: *filterAnnotations()*
      *
      * @param string id
      *
      * @return string
      */
    getAnnotationText(id) {
      const element = document.getElementById(id);

      return element !== null
        ? element.innerText
        : false;
    },
    /**
      * get annotations of the current item
      * caller: *getItemData()*
      *
      * @param string url
      */
    getAnnotations(url) {
      this.request(url)
        .then((annotations) => {
          if (annotations.annotationCollection.first) {
            this.request(annotations.annotationCollection.first)
              .then((current) => {
                if (current.annotationPage.items && current.annotationPage.items.length) {
                  this.annotations = this.filterAnnotations(current.annotationPage.items);
                } else this.annotations = [];
              });
          }
        })
        .catch(() => {
          this.$q.notify({ message: 'No annotations available' });
        });
    },
schneider210's avatar
schneider210 committed
207
208
209
210
211
212
213
214
    /**
      * get collection data according to 'entrypoint'
      * (number of requests equal the number of manifests contained within a collection)
      * initialize the tree's root node
      * caller: *init()*
      *
      * @param string url
      */
215
    getCollection(url) {
216
217
      this.isCollection = true;

218
219
220
      this.request(url)
        .then((data) => {
          this.collection = data;
221
          this.collectiontitle = this.getLabel(data);
222

223
224
225
226
227
228
          this.tree.push(
            {
              children: [],
              handler: (node) => {
                this.$root.$emit('update-tree-knots', node.label);
              },
229
230
              label: this.collectiontitle,
              'label-key': this.collectiontitle,
231
232
233
              selectable: false,
            },
          );
234
235
236
237
238
239

          if (Array.isArray(data.sequence)) {
            data.sequence.forEach((seq) => this.getManifest(seq.id));
          }
        });
    },
schneider210's avatar
schneider210 committed
240
241
242
243
    /**
      * get config object (JSON) from index.html
      * caller: *created-hook*
      */
244
    getConfig() {
245
      this.config = JSON.parse(document.getElementById('tido-config').text);
246
    },
247
    /**
248
      * filter all urls that match either of the MIME types "application/xhtml+xml" and "text/html"
249
250
251
252
253
254
      * caller: *getItemData()*
      *
      * @param string array
      *
      * @return array
      */
255
256
257
258
    getContentUrl(content) {
      const urls = [];

      if (Array.isArray(content) && content.length) {
259
260
        this.contentTypes = [];

261
262
263
        content.forEach((c) => {
          if (c.type.match(/(application\/xhtml\+xml|text\/html)/)) {
            urls.push(c.url);
264
265

            this.contentTypes.push(c.type.split('type=')[1]);
266
267
268
269
          }
        });
      }
      return urls;
270
    },
schneider210's avatar
schneider210 committed
271
272
273
274
275
276
    /**
      * fetch all data provided on 'item level'
      * caller: *mounted-hook*, *getManifest()*
      *
      * @param string url
      */
277
    getItemData(url) {
278
279
      this.request(url)
        .then((data) => {
280
          this.item = data;
281

282
          this.contenturls = this.getContentUrl(data.content);
283
          this.imageurl = data.image.id || '';
284
285
        });
    },
schneider210's avatar
schneider210 committed
286
287
288
289
290
291
292
    /**
      * caller: *getItemUrls()*
      *
      * @param string nodelabel
      *
      * @return number idx
      */
293
294
295
296
297
298
299
300
301
    getItemIndex(nodelabel) {
      let idx = 0;
      this.itemurls.forEach((item, index) => {
        if (item === nodelabel) {
          idx = index;
        }
      });
      return idx;
    },
302
303
304
305
306
307
308
309
310
311
312
    /**
      * extract the 'label part' of the itemurl
      * caller: *getItemUrls()*
      *
      * @param string itemurl
      *
      * @return string 'label part'
      */
    getItemLabel(itemurl) {
      return itemurl.replace(/.*-(.*)\/latest.*$/, '$1');
    },
schneider210's avatar
schneider210 committed
313
314
315
316
317
318
319
320
321
    /**
      * get all itemurls hosted by each manifest's sequence to populate the aprropriate tree node
      * caller: *getManifest()*
      *
      * @param array sequence
      * @param string label
      *
      * @return array urls
      */
322
323
    getItemUrls(sequence, label) {
      const urls = [];
324

325
326
      sequence.forEach((item) => {
        const itemLabel = this.getItemLabel(item.id);
327

328
329
        urls.push(
          {
330
331
            label: item.id,
            'label-key': `${this.config.labels.item} ${itemLabel}`,
332
333
334
335
            handler: (node) => {
              if (this.itemurl === node.label) {
                return;
              }
schneider210's avatar
schneider210 committed
336
337
338
              // node.label === itemurl
              // @param label === manifest label; passed by getManifest()
              this.$root.$emit('update-item', node.label, this.getSequenceIndex(label));
339
              this.$root.$emit('update-item-index', this.getItemIndex(node.label));
340
              this.$root.$emit('update-sequence-index', this.getSequenceIndex(label));
341
342
343
344
345
346
            },
          },
        );
      });
      return urls;
    },
schneider210's avatar
schneider210 committed
347
348
349
350
351
352
353
354
    /**
      * get the collection label, if provided; otherwise get the manifest label
      * caller: *getCollection()*, *getManifest()*
      *
      * @param object data
      *
      * @return string 'label'
      */
355
356
357
358
359
360
    getLabel(data) {
      if (Object.keys(this.collection).length) {
        return data.title && data.title[0].title ? data.title[0].title : data.label;
      }
      return data.label ? data.label : 'Manifest <small>(No label available)</small>';
    },
schneider210's avatar
schneider210 committed
361
362
363
364
365
366
    /**
      * get all the data provided on 'manifest level'
      * caller: *init()*, *getCollection()*
      *
      * @param string url
      */
367
368
369
    getManifest(url) {
      this.request(url)
        .then((data) => {
370
371
372
373
374
          // if the entrypoint points to a single manifest, initialize the tree
          if (this.isCollection === false) {
            this.tree.push({ label: '', 'label-key': this.config.labels.manifest, children: [] });
          }

375
376
377
378
379
380
381
382
383
384
          if (!Array.isArray(data.sequence)) {
            data.sequence = [data.sequence];
          }

          if (data.sequence[0] !== 'undefined') {
            data.sequence.map((seq) => this.itemurls.push(seq.id));
          }
          this.manifests.push(data);

          this.tree[0].children.push(
385
386
            {
              children: this.getItemUrls(data.sequence, data.label),
387
388
389
390
391
392
              label: data.label,
              'label-key': data.label,
              handler: (node) => {
                this.$root.$emit('update-tree-knots', node.label);
              },
              selectable: false,
393
            },
394
395
396
397
          );
          // make sure that urls are set just once on init
          if (!this.itemurl && data.sequence[0]) {
            this.itemurl = data.sequence[0].id;
398
            this.getItemData(data.sequence[0].id);
399
400
401
          }
        });
    },
schneider210's avatar
schneider210 committed
402
403
404
405
406
407
408
    /**
      * caller: *getItemUrls()*
      *
      * @param string label
      *
      * @return number index
      */
409
    getSequenceIndex(label) {
410
411
      let index = 0;
      this.manifests.forEach((manifest, idx) => {
412
        if (manifest.label === label) {
413
414
415
416
417
          index = idx;
        }
      });
      return index;
    },
schneider210's avatar
schneider210 committed
418
419
420
421
422
423
    /**
      * decide whether to start with a collection or a single manifest
      * caller: *created-hook*
      *
      * @return function getCollection() | getManifest()
      */
424
425
426
427
428
429
430
    init() {
      return this.config.entrypoint.match(/collection.json\s?$/)
        ? this.getCollection(this.config.entrypoint)
        : this.getManifest(this.config.entrypoint);
    },
  },

Mathias Goebel's avatar
Mathias Goebel committed
431
432
};
</script>
433
434

<style scoped>
435
.root {
436
437
438
439
440
441
  display: flex;
  flex: 1;
  flex-direction: column;
  overflow: hidden;
}

Mathias Goebel's avatar
Mathias Goebel committed
442
.viewport {
443
  height: 100vh;
444
445
}
</style>