App.vue 9.72 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
7
8
    view="hHh Lpr fFf"
    class="app"
    style="height: 100vh;"
  >
9
10
11
12
13
14
15
16
17
    <Header
      v-if="config.headers.all"
      :collectiontitle="collectiontitle"
      :config="config"
      :imageurl="imageurl"
      :item="item"
      :itemurls="itemurls"
      :manifests="manifests"
      :panels="panels"
18
19
      :projectcolors="config.colors"
      :standalone="config.standalone"
20
    />
21

22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
    <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
39
40
41
</template>

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

Mathias Goebel's avatar
Mathias Goebel committed
46
export default {
47
  name: 'TIDO',
48
49
50
  components: {
    Header,
  },
51
  mixins: [Panels],
52
53
54
  data() {
    return {
      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;
    },
schneider210's avatar
schneider210 committed
128
129
130
131
132
133
134
135
    /**
      * 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
      */
136
    getCollection(url) {
137
138
      this.isCollection = true;

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

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

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

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

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

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

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

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

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

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

<style scoped>
356
.root {
357
358
359
360
361
362
  display: flex;
  flex: 1;
  flex-direction: column;
  overflow: hidden;
}

363
  height: 100vh;
364
365
}
</style>