diva.js 6.0.1 → 7.2.3

package/source/js/parse-iiif-manifest.js

@@ -1,302 +0,0 @@
-import parseLabelValue from './utils/parse-label-value';
-
-const getMaxZoomLevel = (width, height) =>
-{
-    const largestDimension = Math.max(width, height);
-    if (largestDimension < 128) 
-        return 0;
-    return Math.ceil(Math.log((largestDimension + 1) / (256 + 1)) / Math.log(2));
-};
-
-const incorporateZoom = (imageDimension, zoomDifference) => imageDimension / (Math.pow(2, zoomDifference));
-
-const getOtherImageData = (otherImages, lowestMaxZoom) =>
-{
-    return otherImages.map( (itm) =>
-    {
-        const w = itm.width;
-        const h = itm.height;
-        const info = parseImageInfo(itm);
-        const url = info.url.slice(-1) !== '/' ? info.url + '/' : info.url;  // append trailing slash to url if it's not there.
-
-        const dims = new Array(lowestMaxZoom + 1);
-        for (let j = 0; j < lowestMaxZoom + 1; j++)
-        {
-            dims[j] = {
-                h: Math.floor(incorporateZoom(h, lowestMaxZoom - j)),
-                w: Math.floor(incorporateZoom(w, lowestMaxZoom - j))
-            };
-        }
-
-        return {
-            f: info.url,
-            url: url,
-            il: itm.label || "",
-            d: dims
-        };
-    });
-};
-
-const getIIIFPresentationVersion = (context) =>
-{
-    if (context === "http://iiif.io/api/presentation/2/context.json")
-        return 2;
-    else if (Array.isArray(context) && context.includes("http://iiif.io/api/presentation/2/context.json"))
-        return 2;
-    else if (Array.isArray(context) && context.includes("http://iiif.io/api/presentation/3/context.json"))
-        return 3;
-    else
-        return 2; // Assume a v2 manifest.
-};
-
-/**
- * Parses an IIIF Presentation API Manifest and converts it into a Diva.js-format object
- * (See https://github.com/DDMAL/diva.js/wiki/Development-notes#data-received-through-ajax-request)
- *
- * @param {Object} manifest - an object that represents a valid IIIF manifest
- * @returns {Object} divaServiceBlock - the data needed by Diva to show a view of a single document
- */
-export default function parseIIIFManifest (manifest)
-{
-    let ctx = manifest["@context"];
-
-    if (!ctx)
-    {
-        console.error("Invalid IIIF Manifest; No @context found.");
-        return null;
-    }
-
-    const version = getIIIFPresentationVersion(ctx);
-    const sequence = manifest.sequences ? manifest.sequences[0] : null;
-    const canvases = sequence ? sequence.canvases : manifest.items;
-    const numCanvases = canvases.length;
-
-    const pages = new Array(canvases.length);
-
-    let thisCanvas, 
-        thisResource, 
-        thisImage,
-        secondaryImages,
-        otherImages = [],
-        context, 
-        url, 
-        info, 
-        imageAPIVersion, 
-        width, 
-        height, 
-        maxZoom, 
-        canvas, 
-        label, 
-        imageLabel, 
-        zoomDimensions, 
-        widthAtCurrentZoomLevel, 
-        heightAtCurrentZoomLevel;
-
-    let lowestMaxZoom = 100;
-    let maxRatio = 0;
-    let minRatio = 100;
-
-    // quickly determine the lowest possible max zoom level (i.e., the upper bound for images) across all canvases.
-    // while we're here, compute the global ratios as well.
-    for (let z = 0; z < numCanvases; z++)
-    {
-        const c = canvases[z];
-        const w = c.width;
-        const h = c.height;
-        const mz = getMaxZoomLevel(w, h);
-        const ratio = h / w;
-        maxRatio = Math.max(ratio, maxRatio);
-        minRatio = Math.min(ratio, minRatio);
-
-        lowestMaxZoom = Math.min(lowestMaxZoom, mz);
-    }
-
-    /*
-        These arrays need to be pre-initialized since we will do arithmetic and value checking on them
-    */
-    const totalWidths = new Array(lowestMaxZoom + 1).fill(0);
-    const totalHeights = new Array(lowestMaxZoom + 1).fill(0);
-    const maxWidths = new Array(lowestMaxZoom + 1).fill(0);
-    const maxHeights = new Array(lowestMaxZoom + 1).fill(0);
-
-    for (let i = 0; i < numCanvases; i++)
-    {
-        thisCanvas = canvases[i];
-        canvas = thisCanvas['@id'] || thisCanvas.id;
-        label = thisCanvas.label;
-        thisResource = thisCanvas.images ? thisCanvas.images[0].resource : thisCanvas.items[0].items[0].body;
-
-        /*
-         * If a canvas has multiple images it will be encoded
-         * with a resource type of "oa:Choice" (v2) or "Choice" (v3).
-         **/
-        otherImages = []; // reset array
-        if (thisResource['@type'] === "oa:Choice" || thisResource.type === "Choice")
-        {
-            thisImage = thisResource.default || thisResource.items[0];
-            secondaryImages = thisResource.item || thisResource.items.slice(1);
-            otherImages = getOtherImageData(secondaryImages, lowestMaxZoom);
-        }
-        else
-        {
-            thisImage = thisResource;
-        }
-
-        // Prioritize the canvas height / width first, since images may not have h/w
-        width = thisCanvas.width || thisImage.width;
-        height = thisCanvas.height || thisImage.height;
-
-        if (width <= 0 || height <= 0)
-        {
-            console.warn('Invalid width or height for canvas ' + label + '. Skipping');
-            continue;
-        }
-
-        maxZoom = getMaxZoomLevel(width, height);
-
-        imageLabel = thisImage.label || null;
-
-        info = parseImageInfo(thisImage);
-        url = info.url.slice(-1) !== '/' ? info.url + '/' : info.url;  // append trailing slash to url if it's not there.
-
-        context = thisImage.service['@context'] || thisImage.service.type;
-
-        if (context === 'http://iiif.io/api/image/2/context.json' || context === "ImageService2")
-        {
-            imageAPIVersion = 2;
-        }
-        else if (context === 'http://library.stanford.edu/iiif/image-api/1.1/context.json')
-        {
-            imageAPIVersion = 1.1;
-        }
-        else
-        {
-            imageAPIVersion = 1.0;
-        }
-
-        zoomDimensions = new Array(lowestMaxZoom + 1);
-
-        for (let k = 0; k < lowestMaxZoom + 1; k++)
-        {
-            widthAtCurrentZoomLevel = Math.floor(incorporateZoom(width, lowestMaxZoom - k));
-            heightAtCurrentZoomLevel = Math.floor(incorporateZoom(height, lowestMaxZoom - k));
-            zoomDimensions[k] = {
-                h: heightAtCurrentZoomLevel,
-                w: widthAtCurrentZoomLevel
-            };
-
-            totalWidths[k] += widthAtCurrentZoomLevel;
-            totalHeights[k] += heightAtCurrentZoomLevel;
-            maxWidths[k] = Math.max(widthAtCurrentZoomLevel, maxWidths[k]);
-            maxHeights[k] = Math.max(heightAtCurrentZoomLevel, maxHeights[k]);
-        }
-
-        let isPaged = thisCanvas.viewingHint !== 'non-paged' || (thisCanvas.behavior ? thisCanvas.behavior[0] !== 'non-paged' : false);
-        let isFacing = thisCanvas.viewingHint === 'facing-pages' || (thisCanvas.behavior ? thisCanvas.behavior[0] === 'facing-pages' : false);
-
-        pages[i] = {
-            d: zoomDimensions,
-            m: maxZoom,
-            l: label,         // canvas label ('page 1, page 2', etc.)
-            il: imageLabel,   // default image label ('primary image', 'UV light', etc.)
-            f: info.url,
-            url: url,
-            api: imageAPIVersion,
-            paged: isPaged,
-            facingPages: isFacing,
-            canvas: canvas,
-            otherImages: otherImages,
-            xoffset: info.x || null,
-            yoffset: info.y || null
-        };
-    }
-
-    const averageWidths = new Array(lowestMaxZoom + 1);
-    const averageHeights = new Array(lowestMaxZoom + 1);
-
-    for (let a = 0; a < lowestMaxZoom + 1; a++)
-    {
-        averageWidths[a] = totalWidths[a] / numCanvases;
-        averageHeights[a] = totalHeights[a] / numCanvases;
-    }
-
-    const dims = {
-        a_wid: averageWidths,
-        a_hei: averageHeights,
-        max_w: maxWidths,
-        max_h: maxHeights,
-        max_ratio: maxRatio,
-        min_ratio: minRatio,
-        t_hei: totalHeights,
-        t_wid: totalWidths
-    };
-
-    // assumes paged is false for non-paged values
-    return {
-        version: version,
-        item_title: parseLabelValue(manifest).label,
-        metadata: manifest.metadata || null,
-        dims: dims,
-        max_zoom: lowestMaxZoom,
-        pgs: pages,
-        paged: manifest.viewingHint === 'paged' || (manifest.behaviour ? manifest.behaviour[0] === 'paged' : false) || (sequence ? sequence.viewingHint === 'paged' : false)
-    };
-}
-
-/**
- * Takes in a resource block from a canvas and outputs the following information associated with that resource:
- * - Image URL
- * - Image region to be displayed
- *
- * @param {Object} resource - an object representing the resource block of a canvas section in a IIIF manifest
- * @returns {Object} imageInfo - an object containing image URL and region
- */
-function parseImageInfo (resource)
-{
-    let url = resource['@id'] || resource.id;
-    const fragmentRegex = /#xywh=([0-9]+,[0-9]+,[0-9]+,[0-9]+)/;
-    let xywh = '';
-    let stripURL = true;
-
-    if (/\/([0-9]+,[0-9]+,[0-9]+,[0-9]+)\//.test(url))
-    {
-        // if resource in image API format, extract region x,y,w,h from URL (after 4th slash from last)
-        // matches coordinates in URLs of the form http://www.example.org/iiif/book1-page1/40,50,1200,1800/full/0/default.jpg
-        const urlArray = url.split('/');
-        xywh = urlArray[urlArray.length - 4];
-    }
-    else if (fragmentRegex.test(url))
-    {
-        // matches coordinates of the style http://www.example.org/iiif/book1/canvas/p1#xywh=50,50,320,240
-        const result = fragmentRegex.exec(url);
-        xywh = result[1];
-    }
-    else if (resource.service && (resource.service['@id'] || resource.service.id))
-    {
-        // this URL excludes region parameters so we don't need to remove them
-        url = resource.service['@id'] || resource.service.id;
-        stripURL = false;
-    }
-
-    if (stripURL)
-    {
-        // extract URL up to identifier (we eliminate the last 5 parameters: /region/size/rotation/quality.format)
-        url = url.split('/').slice(0, -4).join('/');
-    }
-
-    const imageInfo = {
-        url: url
-    };
-
-    if (xywh.length)
-    {
-        // parse into separate components
-        const dimensions = xywh.split(',');
-        imageInfo.x = parseInt(dimensions[0], 10);
-        imageInfo.y = parseInt(dimensions[1], 10);
-        imageInfo.w = parseInt(dimensions[2], 10);
-        imageInfo.h = parseInt(dimensions[3], 10);
-    }
-
-    return imageInfo;
-}