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

21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
    <q-page-container class="root">
      <router-view
        :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
53
  data() {
    return {
      collection: {},
54
      collectiontitle: '',
55
      config: {},
56
      contentTypes: [],
57
      contenturls: [],
schneider210's avatar
schneider210 committed
58
      fontsize: 14,
59
      imageurl: '',
60
      isCollection: false,
61
      item: {},
62
63
64
65
66
67
      itemurl: '',
      itemurls: [],
      manifests: [],
      tree: [],
    };
  },
nwindis's avatar
nwindis committed
68
69
70
71
72
  created() {
    this.getConfig();
    this.init();
    this.itemurls.sort((a, b) => a.localeCompare(b, undefined, { numeric: true }));

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

nwindis's avatar
nwindis committed
75
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
    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);
    });
  },
110
  methods: {
schneider210's avatar
schneider210 committed
111
112
113
114
115
116
117
118
119
120
    /**
      * 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
      */
121
122
123
124
125
126
    async request(url, responsetype = 'json') {
      const response = await fetch(url);
      const data = await (responsetype === 'text' ? response.text() : response.json());

      return data;
    },
schneider210's avatar
schneider210 committed
127
128
129
130
131
132
133
134
    /**
      * 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
      */
135
    getCollection(url) {
136
137
      this.isCollection = true;

138
139
140
      this.request(url)
        .then((data) => {
          this.collection = data;
141
          this.collectiontitle = this.getLabel(data);
142

143
144
145
146
147
148
          this.tree.push(
            {
              children: [],
              handler: (node) => {
                this.$root.$emit('update-tree-knots', node.label);
              },
149
150
              label: this.collectiontitle,
              'label-key': this.collectiontitle,
151
152
153
              selectable: false,
            },
          );
154
155
156
157
158
159

          if (Array.isArray(data.sequence)) {
            data.sequence.forEach((seq) => this.getManifest(seq.id));
          }
        });
    },
schneider210's avatar
schneider210 committed
160
161
162
163
    /**
      * get config object (JSON) from index.html
      * caller: *created-hook*
      */
164
    getConfig() {
165
      this.config = JSON.parse(document.getElementById('tido-config').text);
166
    },
167
    /**
168
      * filter all urls that match either of the MIME types "application/xhtml+xml" and "text/html"
169
170
171
172
173
174
      * caller: *getItemData()*
      *
      * @param string array
      *
      * @return array
      */
175
176
177
178
    getContentUrl(content) {
      const urls = [];

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

181
182
183
        content.forEach((c) => {
          if (c.type.match(/(application\/xhtml\+xml|text\/html)/)) {
            urls.push(c.url);
184
185

            this.contentTypes.push(c.type.split('type=')[1]);
186
187
188
189
          }
        });
      }
      return urls;
190
    },
schneider210's avatar
schneider210 committed
191
192
193
194
195
196
    /**
      * fetch all data provided on 'item level'
      * caller: *mounted-hook*, *getManifest()*
      *
      * @param string url
      */
197
    getItemData(url) {
198
199
      this.request(url)
        .then((data) => {
200
          this.item = data;
201

202
          this.contenturls = this.getContentUrl(data.content);
203
          this.imageurl = data.image.id || '';
204
205
        });
    },
schneider210's avatar
schneider210 committed
206
207
208
209
210
211
212
    /**
      * caller: *getItemUrls()*
      *
      * @param string nodelabel
      *
      * @return number idx
      */
213
214
215
216
217
218
219
220
221
    getItemIndex(nodelabel) {
      let idx = 0;
      this.itemurls.forEach((item, index) => {
        if (item === nodelabel) {
          idx = index;
        }
      });
      return idx;
    },
222
223
224
225
226
227
228
229
230
231
232
    /**
      * 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
233
234
235
236
237
238
239
240
241
    /**
      * 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
      */
242
243
    getItemUrls(sequence, label) {
      const urls = [];
244

245
246
      sequence.forEach((item) => {
        const itemLabel = this.getItemLabel(item.id);
247

248
249
        urls.push(
          {
250
251
            label: item.id,
            'label-key': `${this.config.labels.item} ${itemLabel}`,
252
253
254
255
            handler: (node) => {
              if (this.itemurl === node.label) {
                return;
              }
schneider210's avatar
schneider210 committed
256
257
258
              // node.label === itemurl
              // @param label === manifest label; passed by getManifest()
              this.$root.$emit('update-item', node.label, this.getSequenceIndex(label));
259
              this.$root.$emit('update-item-index', this.getItemIndex(node.label));
260
              this.$root.$emit('update-sequence-index', this.getSequenceIndex(label));
261
262
263
264
265
266
            },
          },
        );
      });
      return urls;
    },
schneider210's avatar
schneider210 committed
267
268
269
270
271
272
273
274
    /**
      * get the collection label, if provided; otherwise get the manifest label
      * caller: *getCollection()*, *getManifest()*
      *
      * @param object data
      *
      * @return string 'label'
      */
275
276
277
278
279
280
    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
281
282
283
284
285
286
    /**
      * get all the data provided on 'manifest level'
      * caller: *init()*, *getCollection()*
      *
      * @param string url
      */
287
288
289
    getManifest(url) {
      this.request(url)
        .then((data) => {
290
291
292
293
294
          // 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: [] });
          }

295
296
297
298
299
300
301
302
303
304
          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(
305
306
            {
              children: this.getItemUrls(data.sequence, data.label),
307
308
309
310
311
312
              label: data.label,
              'label-key': data.label,
              handler: (node) => {
                this.$root.$emit('update-tree-knots', node.label);
              },
              selectable: false,
313
            },
314
315
316
317
          );
          // make sure that urls are set just once on init
          if (!this.itemurl && data.sequence[0]) {
            this.itemurl = data.sequence[0].id;
318
            this.getItemData(data.sequence[0].id);
319
320
321
          }
        });
    },
schneider210's avatar
schneider210 committed
322
323
324
325
326
327
328
    /**
      * caller: *getItemUrls()*
      *
      * @param string label
      *
      * @return number index
      */
329
    getSequenceIndex(label) {
330
331
      let index = 0;
      this.manifests.forEach((manifest, idx) => {
332
        if (manifest.label === label) {
333
334
335
336
337
          index = idx;
        }
      });
      return index;
    },
schneider210's avatar
schneider210 committed
338
339
340
341
342
343
    /**
      * decide whether to start with a collection or a single manifest
      * caller: *created-hook*
      *
      * @return function getCollection() | getManifest()
      */
344
345
346
347
348
349
350
    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
351
352
};
</script>
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368

<style scoped>
.app {
  display: flex;
  flex: 1;
  flex-direction: column;
  overflow: hidden;
}

.root {
  display: flex;
  flex: 1;
  flex-direction: column;
  overflow: hidden;
}
</style>