App.vue 9.87 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
17
    <Header
      v-if="config.headers.all"
      :collectiontitle="collectiontitle"
      :config="config"
      :imageurl="imageurl"
      :item="item"
      :itemurls="itemurls"
      :manifests="manifests"
      :panels="panels"
    />
18

19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
    <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>
35

36
    <q-footer>
nwindis's avatar
DUMP    
nwindis committed
37
38
      <Footer
        :projectcolors="config.colors"
schneider210's avatar
schneider210 committed
39
        :standalone="config.standalone"
nwindis's avatar
nwindis committed
40
      />
41
42
    </q-footer>
  </q-layout>
Mathias Goebel's avatar
Mathias Goebel committed
43
44
45
</template>

<script>
schneider210's avatar
schneider210 committed
46
import { colors } from 'quasar';
schneider210's avatar
schneider210 committed
47
import Footer from '@/components/footer.vue';
48
import Header from '@/components/header.vue';
49
import Panels from '@/mixins/panels';
50

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

schneider210's avatar
schneider210 committed
80
81
    this.$q.dark.set('auto');

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

145
146
147
      this.request(url)
        .then((data) => {
          this.collection = data;
148
          this.collectiontitle = this.getLabel(data);
149

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

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

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

188
189
190
        content.forEach((c) => {
          if (c.type.match(/(application\/xhtml\+xml|text\/html)/)) {
            urls.push(c.url);
191
192

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

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

252
253
      sequence.forEach((item) => {
        const itemLabel = this.getItemLabel(item.id);
254

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

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

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

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