App.vue 10.5 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

    /**
      * 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) => {
Mathias Goebel's avatar
Mathias Goebel committed
140
                if (current.annotationPage.items.length) {
141
                  this.annotations = current.annotationPage.items;
142
143
144
145
146
147
148
149
                } else this.annotations = [];
              });
          }
        })
        .catch(() => {
          this.$q.notify({ message: 'No annotations available' });
        });
    },
schneider210's avatar
schneider210 committed
150
151
152
153
154
155
156
157
    /**
      * 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
      */
158
    getCollection(url) {
159
160
      this.isCollection = true;

161
162
163
      this.request(url)
        .then((data) => {
          this.collection = data;
164
          this.collectiontitle = this.getLabel(data);
165

166
167
168
169
170
171
          this.tree.push(
            {
              children: [],
              handler: (node) => {
                this.$root.$emit('update-tree-knots', node.label);
              },
172
173
              label: this.collectiontitle,
              'label-key': this.collectiontitle,
174
175
176
              selectable: false,
            },
          );
177
178
179
180
181
182

          if (Array.isArray(data.sequence)) {
            data.sequence.forEach((seq) => this.getManifest(seq.id));
          }
        });
    },
schneider210's avatar
schneider210 committed
183
184
185
186
    /**
      * get config object (JSON) from index.html
      * caller: *created-hook*
      */
187
    getConfig() {
188
      this.config = JSON.parse(document.getElementById('tido-config').text);
189
    },
190
    /**
191
      * filter all urls that match either of the MIME types "application/xhtml+xml" and "text/html"
192
193
194
195
196
197
      * caller: *getItemData()*
      *
      * @param string array
      *
      * @return array
      */
198
    getContentUrls(content) {
199
200
201
      const urls = [];

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

204
205
206
        content.forEach((c) => {
          if (c.type.match(/(application\/xhtml\+xml|text\/html)/)) {
            urls.push(c.url);
207
208

            this.contentTypes.push(c.type.split('type=')[1]);
209
210
211
212
          }
        });
      }
      return urls;
213
    },
schneider210's avatar
schneider210 committed
214
215
216
217
218
219
    /**
      * fetch all data provided on 'item level'
      * caller: *mounted-hook*, *getManifest()*
      *
      * @param string url
      */
220
    getItemData(url) {
221
222
      this.request(url)
        .then((data) => {
223
          this.item = data;
224

225
          this.contenturls = this.getContentUrls(data.content);
226
          this.imageurl = data.image.id || '';
227
228
229
230

          if (data.annotationCollection) {
            this.getAnnotations(data.annotationCollection);
          }
231
232
        });
    },
schneider210's avatar
schneider210 committed
233
234
235
236
237
238
239
    /**
      * caller: *getItemUrls()*
      *
      * @param string nodelabel
      *
      * @return number idx
      */
240
241
242
243
244
245
246
247
248
    getItemIndex(nodelabel) {
      let idx = 0;
      this.itemurls.forEach((item, index) => {
        if (item === nodelabel) {
          idx = index;
        }
      });
      return idx;
    },
249
250
251
252
253
254
255
256
257
258
259
    /**
      * 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
260
261
262
263
264
265
266
267
268
    /**
      * 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
      */
269
270
    getItemUrls(sequence, label) {
      const urls = [];
271

272
273
      sequence.forEach((item) => {
        const itemLabel = this.getItemLabel(item.id);
274

275
276
        urls.push(
          {
277
278
            label: item.id,
            'label-key': `${this.config.labels.item} ${itemLabel}`,
279
280
281
282
            handler: (node) => {
              if (this.itemurl === node.label) {
                return;
              }
schneider210's avatar
schneider210 committed
283
284
285
              // node.label === itemurl
              // @param label === manifest label; passed by getManifest()
              this.$root.$emit('update-item', node.label, this.getSequenceIndex(label));
286
              this.$root.$emit('update-item-index', this.getItemIndex(node.label));
287
              this.$root.$emit('update-sequence-index', this.getSequenceIndex(label));
288
289
290
291
292
293
            },
          },
        );
      });
      return urls;
    },
schneider210's avatar
schneider210 committed
294
295
296
297
298
299
300
301
    /**
      * get the collection label, if provided; otherwise get the manifest label
      * caller: *getCollection()*, *getManifest()*
      *
      * @param object data
      *
      * @return string 'label'
      */
302
303
304
305
306
307
    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
308
309
310
311
312
313
    /**
      * get all the data provided on 'manifest level'
      * caller: *init()*, *getCollection()*
      *
      * @param string url
      */
314
315
316
    getManifest(url) {
      this.request(url)
        .then((data) => {
317
318
319
320
321
          // 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: [] });
          }

322
323
324
325
326
327
328
329
330
331
          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(
332
333
            {
              children: this.getItemUrls(data.sequence, data.label),
334
335
336
337
338
339
              label: data.label,
              'label-key': data.label,
              handler: (node) => {
                this.$root.$emit('update-tree-knots', node.label);
              },
              selectable: false,
340
            },
341
342
343
344
          );
          // make sure that urls are set just once on init
          if (!this.itemurl && data.sequence[0]) {
            this.itemurl = data.sequence[0].id;
345
            this.getItemData(data.sequence[0].id);
346
347
348
          }
        });
    },
schneider210's avatar
schneider210 committed
349
350
351
352
353
354
355
    /**
      * caller: *getItemUrls()*
      *
      * @param string label
      *
      * @return number index
      */
356
    getSequenceIndex(label) {
357
358
      let index = 0;
      this.manifests.forEach((manifest, idx) => {
359
        if (manifest.label === label) {
360
361
362
363
364
          index = idx;
        }
      });
      return index;
    },
schneider210's avatar
schneider210 committed
365
366
367
368
369
370
    /**
      * decide whether to start with a collection or a single manifest
      * caller: *created-hook*
      *
      * @return function getCollection() | getManifest()
      */
371
372
373
374
375
376
377
    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
378
379
};
</script>
380
381

<style scoped>
382
.root {
383
384
385
386
387
388
  display: flex;
  flex: 1;
  flex-direction: column;
  overflow: hidden;
}

Mathias Goebel's avatar
Mathias Goebel committed
389
.viewport {
390
  height: 100vh;
391
392
}
</style>