util.js

//
// Copyright (C) 2014 University of Dundee & Open Microscopy Environment.
// All rights reserved.
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.
//

import $ from "jquery";
import * as bootstrap from 'bootstrap'
import _ from 'underscore';

// http://www.sitepoint.com/javascript-json-serialization/
JSON.stringify = JSON.stringify || function (obj) {
    var t = typeof (obj);
    if (t != "object" || obj === null) {
        // simple data type
        if (t == "string") obj = '"'+obj+'"';
        return String(obj);
    }
    else {
        // recurse array or object
        var n, v, json = [], arr = (obj && obj.constructor == Array);
        for (n in obj) {
            v = obj[n]; t = typeof(v);
            if (t == "string") v = '"'+v+'"';
            else if (t == "object" && v !== null) v = JSON.stringify(v);
            json.push((arr ? "" : '"' + n + '":') + String(v));
        }
        return (arr ? "[" : "{") + String(json) + (arr ? "]" : "}");
    }
};


// Polyfill for IE
// https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/endsWith
if (!String.prototype.endsWith)
  String.prototype.endsWith = function(searchStr, Position) {
      // This works much better than >= because
      // it compensates for NaN:
      if (!(Position < this.length))
        Position = this.length;
      else
        Position |= 0; // round position
      return this.substr(Position - searchStr.length,
                         searchStr.length) === searchStr;
  };

export const showExportAsJsonModal = function(figureJSON) {
    var figureText = JSON.stringify(figureJSON, null, 2);
    showModal('exportJsonModal');
    $('#exportJsonModal textarea').text(figureText);
}

export const saveFigureToStorage = function (figureJSON) {
    window.sessionStorage.setItem(LOCAL_STORAGE_RECOVERED_FIGURE, JSON.stringify(figureJSON));
}

export const clearFigureFromStorage = function() {
    window.sessionStorage.removeItem(LOCAL_STORAGE_RECOVERED_FIGURE);
}

export const recoverFigureFromStorage = function() {
    var storage = window.sessionStorage;
    var recoveredFigure = storage.getItem(LOCAL_STORAGE_RECOVERED_FIGURE);
    var figureObject;
    try {
        figureObject = JSON.parse(recoveredFigure);
    } catch (e) {
        console.log("recovered Figure not valid JSON " + recoveredFigure);
    }
    return figureObject;
}

var confirmModal = new bootstrap.Modal('#confirmModal');

export function figureConfirmDialog(title, message, buttons, callback) {
    var $confirmModal = $("#confirmModal"),
        $title = $(".modal-title", $confirmModal),
        $body = $(".modal-body", $confirmModal),
        $footer = $(".modal-footer", $confirmModal),
        $btn = $(".btn:first", $footer);

    // Update modal with params
    $title.html(title);
    $body.html('<p>' + message + '<p>');
    $footer.empty();
    _.each(buttons, function(txt){
        $btn.clone().text(txt).appendTo($footer);
    });
    $(".btn", $footer).removeClass('btn-primary')
        .addClass('btn-default')
        .last()
        .removeClass('btn-default')
        .addClass('btn-primary');

    // show modal
    confirmModal.show();

    // default handler for 'cancel' or 'close'
    $confirmModal.one('hide.bs.modal', function() {
        // remove the other 'one' handler below
        $("#confirmModal .modal-footer .btn").off('click');
        if (callback) {
            callback();
        }
    });

    // handle 'Save' btn click.
    $("#confirmModal .modal-footer .btn").one('click', function(event) {
        // remove the default 'one' handler above
        $confirmModal.off('hide.bs.modal');
        var btnText = $(event.target).text();
        if (callback) {
            callback(btnText);
        }
    });
};

if (window.OME === undefined) {
    window.OME = {};
}

export let OPEN_WITH = [];

OME.setOpenWithEnabledHandler = function(id, fn) {
    // look for id in OPEN_WITH
    OPEN_WITH.forEach(function(ow){
        if (ow.id === id) {
            ow.isEnabled = function() {
                // wrap fn with try/catch, since error here will break jsTree menu
                var args = Array.from(arguments);
                var enabled = false;
                try {
                    enabled = fn.apply(this, args);
                } catch (e) {
                    // Give user a clue as to what went wrong
                    console.log("Open with " + label + ": " + e);
                }
                return enabled;
            }
        }
    });
};

// Helper can be used by 'open with' plugins to provide
// a url for the selected objects
OME.setOpenWithUrlProvider = function(id, fn) {
    // look for id in OPEN_WITH
    OPEN_WITH.forEach(function(ow){
        if (ow.id === id) {
            ow.getUrl = fn;
        }
    });
};


// Extend the jQuery UI $.slider() function to silence
// keyboard events on the handle, so we don't nudge selected panels
$.prototype.slider_old = $.prototype.slider;
$.prototype.slider = function() {
    var result = $.prototype.slider_old.apply(this, arguments);
    this.find(".ui-slider-handle").bind("keydown", function(){
        return false;
    });
    return result;
}


// Get coordinates for point x, y rotated around cx, cy, by rotation degrees
export function rotatePoint(x, y, cx, cy, rotation) {
    let length = Math.sqrt(Math.pow((x - cx), 2) + Math.pow((y - cy), 2));
    let rot = Math.atan2((y - cy), (x - cx));
    rot = rot + (rotation * (Math.PI / 180));  // degrees to rad
    let dx = Math.cos(rot) * length;
    let dy = Math.sin(rot) * length;
    return { x: cx + dx, y: cy + dy };
}

$(function(){


    // TODO: find replacement for jquery-ui
    // $(".draggable-dialog").draggable();

    $('#previewInfoTabs a').click(function (e) {
        e.preventDefault();
        $(this).tab('show');
    });


    // Header button tooltips
    // $('.btn-sm').tooltip({container: 'body', placement:'bottom', toggle:"tooltip"});
    // $('.figure-title').tooltip({container: 'body', placement:'bottom', toggle:"tooltip"});
    // Footer button tooltips
    // $('.btn-xs').tooltip({container: 'body', placement:'top', toggle:"tooltip"});


    // If we're on Mac, update dropdown menus for keyboard short cuts:
    if (navigator.platform.toUpperCase().indexOf('MAC') > -1) {
        $("ul.dropdown-menu li a span").each(function(){
            var $this = $(this);
                $this.text($this.text().replace("Ctrl+", "⌘"));
        });
    }

    // When we load, setup Open With options
    $.getJSON(WEBGATEWAYINDEX + "open_with/", function(data){
        if (data && data.open_with_options) {
            OPEN_WITH = data.open_with_options;
            // Try to load scripts if specified:
            OPEN_WITH.forEach(function(ow){
                if (ow.script_url) {
                    $.getScript(ow.script_url);
                }
            })
        }
    });

});

export function hideModals() {
    // Calls hide() on all bootstrap Modal dialogs
    $(".modal").each(function() {
        const thisModal = bootstrap.Modal.getInstance(this);
        if (thisModal) {
            thisModal.hide();
        }
    });
};

export function showModal(modalId, args) {
    let thisModal = bootstrap.Modal.getInstance(document.getElementById(modalId));
    if (!thisModal) {
        thisModal = new bootstrap.Modal("#" + modalId);
    }
    thisModal.show(args);
}

export function hideModal(modalId) {
    let thisModal = bootstrap.Modal.getInstance(document.getElementById(modalId));
    if (!thisModal) {
        thisModal = new bootstrap.Modal("#" + modalId);
    }
    thisModal.hide();
}

export async function getJson (url) {
    let cors_headers = { mode: 'cors', credentials: 'include' };
    return fetch(url, cors_headers).then(rsp => rsp.json());
}

export const RANDOM_NUMBER_RANGE = 100000000;

export function getRandomId() {
    return parseInt(Math.random() * RANDOM_NUMBER_RANGE);
}

export function updateRoiIds(panelsJson) {
    // If we copy and paste an inset panel AND it's corresponding panel with Rect,
    // we don't want changes in viewport/Rect to trigger changes in the panels they
    // were copied from - so we update IDs...

    // But, if we ONLY copy/paste a panel containing an Inset Rect, keep the insetRoiId
    // so that it continues to sync with the inset panel.
    // And if we ONLY copy/paste an inset panel, keep the insetRoiId so that it stays
    // in sync with corresponding Rect

    // Find the insetRoiIds that are in BOTH panels and shapes
    let insetIdsFromPanels = panelsJson.map(panel => panel.insetRoiId).filter(Boolean);
    let insetIdsFromShapes = [];
    panelsJson.forEach(panel => {
        if (panel.shapes) {
            panel.shapes.forEach(shape => {
                if (shape.id) {
                    insetIdsFromShapes.push(shape.id);
                }
            });
        }
    });
    let idsToUpdate = insetIdsFromPanels.filter(roiId => insetIdsFromShapes.includes(roiId));

    // Update the IDs
    let toAdd = getRandomId();
    let updatedPanels = panelsJson.map(panelJson => {
        if (idsToUpdate.includes(panelJson.insetRoiId)) {
            panelJson.insetRoiId = (panelJson.insetRoiId + toAdd) % RANDOM_NUMBER_RANGE;
        }
        if (panelJson.shapes) {
            panelJson.shapes.forEach(shape => {
                if (idsToUpdate.includes(shape.id)) {
                    shape.id = (shape.id + toAdd) % RANDOM_NUMBER_RANGE;
                }
            });
        }
        return panelJson;
    });

    return updatedPanels;
}

// Normalize z-projection bounds to be within [0, sizeZ-1] and ensure start <= end
// Takes z_start, z_end, z_projection values and sizeZ, returns normalized bounds
// If sizeZ is 1, disables z_projection and resets to 0
export function normalizeZProjectionBounds(z_start, z_end, z_projection, sizeZ) {
    var result = {
        z_projection: (z_projection === undefined) ? false : z_projection,
        z_start: (z_start === undefined) ? 0 : z_start,
        z_end: (z_end === undefined) ? 0 : z_end
    };

    if (sizeZ === 1) {
        result.z_projection = false;
        result.z_start = 0;
        result.z_end = 0;
    } else {
        // bounds checking and ensures start <= end
        result.z_end = Math.max(Math.min(result.z_end, sizeZ - 1), 0);
        result.z_start = Math.max(Math.min(result.z_start, sizeZ - 1), 0);
        if (result.z_start > result.z_end) {
            var tmp = result.z_start;
            result.z_start = result.z_end;
            result.z_end = tmp;
        }
    }
    return result;
}