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

      <q-page-container>
        <router-view
          :collection="collection"
18
          :config="config"
19
          :contenttypes="contentTypes"
20
          :contenturls="contenturls"
schneider210's avatar
schneider210 committed
21
          :fontsize="fontsize"
22
          :imageurl="imageurl"
23
          :item="item"
24
          :labels="config.labels"
25
          :manifests="manifests"
26
          :panels="panels"
27
28
29
30
          :request="request"
          :tree="tree"
        />
      </q-page-container>
31

nwindis's avatar
DUMP    
nwindis committed
32
33
      <Footer
        :projectcolors="config.colors"
schneider210's avatar
schneider210 committed
34
        :standalone="config.standalone"
nwindis's avatar
nwindis committed
35
      />
36
    </q-layout>
Mathias Goebel's avatar
Mathias Goebel committed
37
38
39
40
  </div>
</template>

<script>
schneider210's avatar
schneider210 committed
41
import { colors } from 'quasar';
schneider210's avatar
schneider210 committed
42
import Footer from '@/components/footer.vue';
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
  components: {
    Header,
50
    Footer,
51
  },
52
  mixins: [Panels],
53
54
55
  data() {
    return {
      collection: {},
56
      collectiontitle: '',
57
      config: {},
58
      contentTypes: [],
59
      contenturls: [],
schneider210's avatar
schneider210 committed
60
      fontsize: 14,
61
      imageurl: '',
62
      isCollection: false,
63
      item: {},
64
65
66
67
68
69
      itemurl: '',
      itemurls: [],
      manifests: [],
      tree: [],
    };
  },
nwindis's avatar
nwindis committed
70
71
72
73
74
  created() {
    this.getConfig();
    this.init();
    this.itemurls.sort((a, b) => a.localeCompare(b, undefined, { numeric: true }));

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

nwindis's avatar
nwindis committed
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
111
    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);
    });
  },
112
  methods: {
schneider210's avatar
schneider210 committed
113
114
115
116
117
118
119
120
121
122
    /**
      * 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
      */
123
124
125
126
127
128
    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
129
130
131
132
133
134
135
136
    /**
      * 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
      */
137
    getCollection(url) {
138
139
      this.isCollection = true;

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

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

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

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

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

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

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

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

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

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