`;
// Implement the assessment template
cardHtmlTemplate[ASSESSMENT] = `
{MODULE_NUM}
Weight: {WEIGHTING}
{DATE}
{COMING_SOON}
{TITLE}
{ASSESSMENT_TYPE}
Learning outcomes: {LEARNING_OUTCOMES}
{DESCRIPTION}
{LINK_ITEM}
{EDIT_ITEM}
`;
// template to add the "ENGAGE" link to (more strongly) indicate that the card links somewhere
var linkItemHtmlTemplate = Array(NUM_TEMPLATES);
linkItemHtmlTemplate[HORIZONTAL] = `
`;
linkItemHtmlTemplate[VERTICAL] = "";
linkItemHtmlTemplate[HORIZONTAL_NOENGAGE] = "";
linkItemHtmlTemplate[PEOPLE] = "";
linkItemHtmlTemplate[ASSESSMENT] = "";
// TODO: need to decide how and what this will look like
//linkItemHtmlTemplate[1] = '
Engage
';
linkItemHtmlTemplate[VERTICAL] = "";
/*`
`;*/
//*****************************************************************
// Templates for the "Mark Review" and "Reviewed" features
var markReviewLinkHtmlTemplate = Array(NUM_TEMPLATES);
var markUnReviewedLinkHtmlTemplate = Array(NUM_TEMPLATES);
markReviewLinkHtmlTemplate[HORIZONTAL] = `
`;
// GLOBALS
const DEFAULT_CARD_LABEL = "Module";
// Big kludge for HDR
function hideJourney($) {
//console.log("---------- RUNNING THE tmp script");
var tweak_bb_active_url_pattern = "listContent.jsp";
window.tweak_bb = {
display_view: location.href.indexOf(tweak_bb_active_url_pattern) > 0,
page_id: "#content_listContainer",
row_element: "li",
};
var journeyTitle = jQuery(tweak_bb.page_id + " > " + tweak_bb.row_element)
.find(".item h3")
.filter(':contains("Your HDR Journey")')
.eq(0);
//console.log(journeyTitle);
var journey = jQuery(journeyTitle)
.parent()
.next("div.details")
.children(".vtbegenerated");
//console.log(journey);
var child = jQuery(journey).children(".yourJourney");
//console.log(child);
jQuery(child).unwrap();
}
/****
* TODO
* - Add a "right now" important way to highlight a card
* - Configure the number of cards and width of cards (e.g. 2 for assessment)
* - Fix issues with formatting within the card
* - Explore the use of opacity to highlight the whole card?
* i.e. an overview that goes over the top? or perhaps just shade bottom same blue as the border with white text
*/
function cardsInterface($) {
// jQuery("ul#content_listContainer").hide();
/* define variables based on Bb page type */
/* used to identify important components in html */
var tweak_bb_active_url_pattern = "listContent.jsp";
window.tweak_bb = {
display_view: location.href.indexOf(tweak_bb_active_url_pattern) > 0,
page_id: "#content_listContainer",
row_element: "li",
};
/* Calculate actual term by using id="courseMenuLink"
* - which includes the courseId */
courseTitle = $("#courseMenu_link").attr("title");
if (location.href.indexOf("listContent.jsp") > 0) {
$(".gutweak").parents("li").hide();
}
//
jQuery("#gu_card_docs").html(DOCUMENTATION_HTML);
jQuery("#gu_card_intro").html(INTRO_HTML);
// Calculate the actual TERM for this course based on the
// courseId. If it doesn't parse, just leave it as the default
// initialised term
[TERM, DEFAULT_YEAR] = calculateTermYear(courseTitle);
LOCATION = location.href.indexOf("listContent.jsp");
// identify the content item to place the cards into
// Looking for the first item with "card interface" in the name
let cardInterface = jQuery(tweak_bb.page_id + " > " + tweak_bb.row_element)
.find(".item h3")
.filter(function (x) {
// check the content of the item, this is the h3 heading
// the content is in the sibling (next) div after the parent of the h3
const isTweakCode =
this.parentNode.nextElementSibling.innerHTML.includes(
'id="gu_card_intro"'
);
const titleIsCardInterface = this.innerText
.toLowerCase()
.includes("card interface");
return titleIsCardInterface && !isTweakCode;
})
.eq(0);
if (cardInterface.length === 0) {
return false;
}
PARAMS = checkParams(cardInterface)
/* Get the titles and descriptions of the items on the page */
var items = getCardItems($);
/* generate the cards interface for the tiems */
//addCardInterface(items);
jQuery(window).on("load", addCardInterface(cardInterface, items));
// remove click event handler from engage buttons
// Add event handler for the engage links
/*jQuery(".gu-engage").click( function(e) {
e.stopPropagation();
});*/
/** ------ cards should be created by now -- */
/* But make all the links in carddescription stop propagation */
var cardContent = jQuery(".carddescription [href]").not(".gu-engage");
for (var i = 0; i < cardContent.length; i++) {
cardContent[i].addEventListener(
"click",
function (e) {
// aim here is to allow internal links to override the
// cardmainlink
e.stopPropagation();
},
false
);
}
/* Make all of the cards clickable by adding an event handler */
// Does this unwrap actually do anything???
//jQuery( ".cardmainlink[href='undefined'" ).contents().unwrap();
//return true;
var cards = document.querySelectorAll(".clickablecard");
//var cards = document.querySelectorAll(".cardmainlink");
for (i = 0; i < cards.length; i++) {
cards[i].addEventListener(
"click",
function (event) {
var link = this.querySelector(".cardmainlink");
if (link !== null) {
// prevent clicking on a undefined blackboard link
if (link.match(/blackboard\/content\/undefined$/)) {
console.log("Undefined");
} else {
link.click();
}
}
},
false
);
}
addButtons();
// if we want the images to be hidden, hide them at the end
if (HIDE_IMAGES) {
jQuery(".bg-cover").hide();
}
// check if the item icons exists, before trying to remove them
let checkIcon = setInterval(function () {
if (jQuery("img.item_icon").length) {
removeBlackboardIcon(cardInterface);
clearInterval(checkIcon);
}
}, 100);
// jQuery("ul#content_listContainer").show();
}
/**
* @desc Identify course term and year from course title
* @param {string} courseTitle course code, name and id in brackets
* @return {Array} term and year
*
* TODO
* - how to handle QCM courses with different calendar
*/
function calculateTermYear(courseTitle) {
let term = TERM,
year = DEFAULT_YEAR;
// get the course id which will be in brackets
// e.g.
// Collapse 1731QCM Creative Studio Practices 1 (1731QCM_3211_SB)
let m = courseTitle.match(/^.*\((.+)\)/);
// we found a course Id, get the STRM value
if (m) {
id = m[1];
// break the course Id up into its components
// Check for an OUA course (e.g. com10) where the letters are first
breakIdRe = new RegExp(
"^([A-Z]+[0-9]+)_([0-9][0-9][0-9][0-9])_([A-Z][A-Z])$"
);
m = id.match(breakIdRe);
// found an actual course site (rather than org site)
if (m) {
term = m[2];
// set the year
mm = term.match(/^[0-9]([0-9][0-9])[0-9]$/);
if (mm) {
year = 20 + mm[1];
} else {
year = DEFAULT_YEAR;
}
} else {
// check for a normal GU course, numbers first
// match an unjoined course
// course code_STRM_offering - 1731QCM_3211_SB
//
breakIdRe = new RegExp(
"^([0-9]+[A-Z]+)_([0-9][0-9][0-9][0-9])_([A-Z][A-Z0-9])$"
);
m = id.match(breakIdRe);
if (m) {
// found an actual course site (rather than org site)
term = m[2];
// set the year
mm = term.match(/^[0-9]([0-9][0-9])[0-9]$/);
if (mm) {
year = 20 + mm[1];
} else {
year = DEFAULT_YEAR;
}
} else {
// Match a joined course (no offering on the end)
breakIdRe = new RegExp("^([0-9]+[A-Z]+)_([0-9][0-9][0-9][0-9])$");
m = id.match(breakIdRe);
// found an actual course site (rather than org site)
if (m) {
term = m[2];
// set the year
mm = term.match(/^[0-9]([0-9][0-9])[0-9]$/);
if (mm) {
year = 20 + mm[1];
} else {
year = DEFAULT_YEAR;
}
} else {
// Match Y1 QCM courses e.g. 3526QCM_Y1_3211_SB
breakIdRe = new RegExp(
"^([0-9]+[A-Z]+)_(Y[0-9])_([0-9][0-9][0-9][0-9])_([A-Z][A-Z])$"
);
m = id.match(breakIdRe);
if (m) {
term = m[3];
mm = term.match(/^[0-9]([0-9][0-9])[0-9]$/);
if (mm) {
year = 20 + mm[1];
} else {
year = DEFAULT_YEAR;
}
}
}
}
}
// if this is a QCM course (either offering of joined), then update term
let qcmRe = new RegExp("^([0-9]+QCM)_([0-9][0-9][0-9][0-9])");
let qcmRe2 = new RegExp("^([0-9]+QCM)_(Y[0-9])_([0-9][0-9][0-9][0-9])");
m = id.match(qcmRe);
let m2 = id.match(qcmRe2);
if (m || m2) {
term = term + "QCM";
}
}
// console.log( `cards.js::calculateTermYear - id is ${id} Term is ${term} Year is ${year}`);
return [term, year];
}
/***
* Extract an array of items from the page that have been specified as part
* of the card interface
*/
function getCardItems($) {
// Find all the items that containg Card Image: OR Card Image Iframe:
// Case insensitive
// This will include any Content Item that includes this string
// even if it isn't meant to be a card
var cardRE = new RegExp("(card image) ?(iframe)?:", "i");
var bbItems = jQuery(tweak_bb.page_id + " > " + tweak_bb.row_element)
.children(".details")
.children(".vtbegenerated")
.filter(function () {
return this.innerHTML.match(cardRE);
// SKETCHY TODO
//return match = this.innerHTML.match(cardRE);
});
var cards = extractCardsFromContent(bbItems);
return cards;
}
/**
* @function extractCardMetaData
* @param {jQuery} descriptionObject contain content of Blackboard content item
* @returns {Object} Each field has a meta data value extracted from descriptionObject
*
* Assumes description is broken in
but checks with.
*/
const CARD_METADATA_FIELDS = [
"card label",
"card number",
"card date",
"card date label",
"card engage",
"card coming soon",
"card coming soon label",
"assessment type",
"assessment weighting",
"assessment outcomes",
"card image",
"card image iframe",
"card image background",
"card image size",
"card image active",
];
function extractCardMetaData(descriptionObject) {
// define hash to put values into it
let metaDataValues = {};
let description = jQuery(descriptionObject).html();
// remove new lines from description
description = description.replace(/(?:\r\n|\r|\n)/g, " ");
// break up description into collection of ps and focus
// use outerHTML to get the surrounding
etc so that it can be removed from
// the description
// TODO: Does this change screw up the complex shit that other people can
// do when they use line breaks, include HTML etc
let elementHtmlObjects = jQuery(descriptionObject).find("p");
let elementContent = jQuery(elementHtmlObjects)
.toArray()
.map((x) => x.innerHTML);
let tmpMetaData = [];
//console.log("----------------------- extractCardMetaData");
// check and break up the ps into individual bits of meta data
let maxLength = elementContent.length;
for (i = 0; i < maxLength; i++) {
// console.log(` _____________ working on para ${i} == ${elementContent[i]}`);
// work on a temp copy of description
//let partialDescription = elementContent[i].innerHTML;
let partialDescription = elementContent[i];
// get rid of newlines (definitely needed)
partialDescription = partialDescription.replace(/(?:\r\n|\r|\n)/g, " ");
CARD_METADATA_FIELDS.forEach(function (element) {
// search for the element, but initially assume that there is another
// metadata variable within the current item (i.e.
)
// This happens when a is used, rather than
between metadata
// look for element, followed by a card metadata
let re = new RegExp(
"(" +
element +
"\\s*:\\s*.*)cards+(?:label|number|date|date label|image size|image active)[^:]*:",
"mi"
);
let m = partialDescription.match(re);
// if not, check for assessment
if (!m) {
re = new RegExp(
"(" +
element +
"\\s*:\\s*.*)assessments+(?:type|weighting|outcomes)[^:]*:",
"mi"
);
m = partialDescription.match(re);
}
// if found, then we need extract just the matched element, leaving
// the rest for a later iteration
if (m) {
// console.log(` -- found partial Descripiton match ${m[1]}`);
// remove match from partialDescription, leaving any other potential
// card stuff there for later (hence why m[1], not m[0])
partialDescription = partialDescription.replace(m[1], "");
// remove the match from the broader description
//description = description.replace(m[1],'');
// TODO does raise the question of why m[0] okay here
description = description.replace(m[1], "");
// added element for later processing - but remove the
tmpMetaData.push(m[1].replace(/ /gi, " "));
} else {
// the
contains just the one metadata, replace the whole para
// bad at RE, so check if it's the last one
// console.log(" -- bad RE???");
re = new RegExp("(" + element + "\\s*:\\s*.*)", "mi");
// re = new RegExp( "$", "mi" );
m = partialDescription.match(re);
if (m) {
// remove it from partial description
//partialDescription = partialDescription.replace(re,'');
partialDescription = partialDescription.replace(m[1], "");
// remove the match from the broader description
// TODO doesn't remove the surrounding
// description = description.replace(m[1],'');
description = description.replace(m[1], "");
// added element for later processing - but remove any
tmpMetaData.push(m[1].replace(/ /gi, " "));
} else {
//console.log(` Search for ${element} no match`);
}
}
});
}
// console.log("---------------------- Finished parsing Ps");
// console.log(tmpMetaData);
// At this stage tmpMetaData contains "html" for each card meta data
// format should be "card label: value"
// Loop thru each tmpMetaData element and extract value appropriately
// place in an object label -> value
for (i = 0; i < tmpMetaData.length; i++) {
// extract the metaData label m[1] and value m[2]
let re = new RegExp("\\s*(card\\s*[^:]*)\\s*:\\s*(.*)", "im");
let m = tmpMetaData[i].match(re, "im");
// didn't find a card value, try one of the assessment ones
if (!m) {
re = new RegExp("\\s*(assessment\\s*[^:]*)\\s*:\\s*(.*)", "im");
m = tmpMetaData[i].match(re, "im");
}
if (m) {
// extract label and value
// ensure label matches METADATA name archetypes
let label = m[1].trim().replace(/\\s*/, " ").toLowerCase();
let value = m[2];
// make sure the HTML in value is valid
let div = document.createElement("div");
div.innerHTML = value;
let newValue = div.innerHTML;
metaDataValues[label] = newValue;
} else {
}
}
// used to edit the description element and ensure that it is correct HTML
let div = document.createElement("div");
div.innerHTML = description;
// not used in inlineImage (yet)
// Aim here is to what?
// - find any image that has a title Card Image **this one**
// - set any inline image to have a card title Card Image
const regex = /^card image$/i;
let inlineImage = jQuery(descriptionObject)
.find("img")
.filter(function (x) {
const title = jQuery(this).attr("title") || "";
//return ( typeof(title)!=="undefined" && title.match(regex) );
return title.match(regex);
});
// Exclude /images/ci/icon/cmlink_generic.gif from img
if (inlineImage.length && !inlineImage[0].src.includes(BBIMG)) {
// we have real image
// replace the card image value with the inline image
metaDataValues["card image"] = inlineImage[0].src;
// remove the inline image content from the description
let img = jQuery(div).find(`img[src="${inlineImage[0].src}"]`).remove();
}
// there may also be other .contextMenuContainer elements that will need to be removed
// because Bb needs to do more work, but only does it if they are in .vtbgenerated (which cards are not)
// there may be other Bb additions that need cleaning
// e.g.
// - TODO spans with attr data-ally-scoreindicator
// remove the .contextMenuContainers from description
let menuContainers = jQuery(div).find(".contextMenuContainer").remove();
// Make sure that the description is valid HTML (mostly closing tags)
// jQuery handles this by default
description = div.innerHTML;
// remove any empty
tags from desciption
description = description.replace(/
\s*<\/p>/g, "");
// add the description minus metadata to metaDataValues, for later use
metaDataValues["description"] = description;
return metaDataValues;
}
//------------------------------------------------------
// FUNCTIONS to handle card meta data changes
//handleCardImage()
// - given value associated with "card image", could be URL or html
function handleCardImage(param) {
let picUrl = "",
cardBGcolour = "black";
// is it a data URI, just return it
regex = /^data:((?:\w+\/(?:(?!;).)+)?)((?:;[\w\W]*?[^;])*),(.+)$/;
if (regex.test(param)) {
return [param, cardBGcolour];
}
// check to see if it's a colour, rather than an image
// TODO might need to modify identifyPicUrl to remove extraneous
// lead html if there is a href?? after img src is checked??
picUrl = identifyPicUrl(param);
cardBGcolour = identifyCardBackgroundColour(param);
// TODO/CHECK previously there was a test to remove a trainling
from end
// Maybe this should be handled in the picURL
return [picUrl.trim(), cardBGcolour];
}
// handleCardImageIframe
// - given the HTML for an iframe, modify any height/width params
// to be more responsive
function handleCardImageIframe(param) {
// replace the width and height
// width should be 100%
// height auto
x = param.match(/width="[^"]+"/i);
if (x) {
param = param.replace(x[0], 'width="100%"');
}
x = param.match(/height="[^"]+"/i);
if (x) {
param = param.replace(x[0], 'height="auto"');
}
// also need to replace any style attributes
x = param.match(/style="[^"]+"/i);
if (x) {
param = param.replace(x[0], "");
}
return param;
}
// handleCardImageSize
// - return contain if set
function handleCardImageSize(param) {
if (param.includes("contain")) {
return "contain";
}
return "";
}
//**************************************************
// handleCardDate( description )
// - given a description for an item find and parse Card Date
// - return an object that has two members
// - start - start or only date {date:??,month:??}
// - stop - end date
// Options include
// - specify specific date by text
// Card Date: Mar 5
// - specify date by text and time
// Card Date: HH:MM Mar 5
// - specify date by week of Griffith term (monday)
// Card Date: Week 1
// - specify date by week of Griffith term (monday) and time
// Card Date: HH:MM Week 1
// - specify a date range
// Card Date: Mar 5-Mar 10
// Card Date: Week 3-5
// - specify a day of the week
// Card Date: Monday Week 5
// Card Date: Mon Week 5
// - specify a day of the week
// Add HH::MM to the front of the above
function handleCardDate(param) {
let empty1 = { date: "", week: "" };
let empty2 = { date: "", week: "" };
let date = { start: empty1, stop: empty2 }; // object to return
param = param.replace(/<[^>]+>/, "");
// is it a range (i.e. contain a -)
let m = param.match(/^(.*)-(.*)$/);
if (m) {
// get first date and break it down
date.start = parseDate(m[1]);
// get second date and break it down
// TODO Week 3-5 results in m[2] being just 5 (need to add week)
// m[2]==int then add week
date.stop = parseDate(m[2].trim(), true);
// if ( /^\+?(0|[1-9]\d*)$/.test(m[2].trim()) ) {
// m[2] = "Week ".concat(m[2].trim());
// }
// date.stop = parseDate(m[2]);
if (
typeof date.start !== "undefined" &&
"stop" in date &&
"time" in date.stop &&
date.stop.time === ""
) {
date.stop.time = "23:59";
}
} else {
// not a range
// get the date and break it down
date.start = parseDate(param);
}
if (typeof date === "undefined") {
return { start: empty1, stop: empty2 };
}
// if no time defined, set the default (midnight)
if (typeof date.start !== "undefined" && date.start.time === "") {
date.start.time = "0:01";
}
return date;
}
/**
* @function parseDate
* @param {String} param
* @param {Boolean} endRange is the date the end of a date range?
* @returns {Object} date
* @description Convert string date - (HH:MM) (Week 1) (Mar 25) into date
* If endRange and date is trimester week, then get the date for Friday
*/
function parseDate(param, endRange = false) {
let date = {}; // object to return
let time = "";
// check for a time at the start of the date and save it away
// then add it at the end
// HH:MM 24-hour format, optional leading 0, but with whitespace at end
const regex = /\s*([0-9]|0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]\s*/;
let m = param.match(regex);
if (m) {
// save the time
time = m[0];
// remove time from param
param = param.replace(regex, "");
}
// a number by itself is the scond part of a week period
// add week
if (/^\+?(0|[1-9]\d*)$/.test(param)) {
param = "Week ".concat(param);
}
// is it a week of trimester
m = param.match(/^\s*week\s*([0-9]*)/i);
if (m) {
week = m[1];
if (!endRange) {
// if not end of range, just get Monday
date = getTermDate(week);
} else {
// end of range should be set to Friday
date = getTermDate(week, true, "Fri");
}
} else {
// does it have a day of week
// start date becomes start of week + number of days in
m = param.match(
/^\s*\b(((mon|tue(s)?|wed(nes)?|thu|thur(s)?|fri|sat(ur)?|sun)(day)?))\b\s*week *([0-9]*)\s*$/i
);
if (m) {
day = m[1];
week = m[m.length - 1];
date = getTermDate(week, true, day);
} else {
// is it the an actual date
m = param.match(/ *([a-z]+) ([0-9]+)/i);
if (m) {
date = { month: m[1], date: m[2], year: DEFAULT_YEAR };
}
//else {
// Fall back to check for exam period
// m = param.match(/ *exam *(period)*/i);
// if (m) {
// date.start = getTermDate('exam');
// date.stop = getTermDate('exam', false);
// }
// }
}
}
if (typeof date !== "undefined") {
if (time !== "") {
date.time = time;
} else {
date.time = "";
}
}
return date;
}
// Given some HTML, remove all the HTML code, trim and return the text
function cleanTrimHtml(html) {
const aux = document.createElement("div");
aux.innerHTML = html;
return aux.innerText.trim();
}
// handleCardLabelNumber
// - given hash with last number for each label type and label and number
// return the appropriate [ label, number] to use for the card
// - label is the label specified for the card,
// - if nothing, default to module
// - number specify card number,
// - if nothing & nothing in numbering element set to 1,
// - else set to the next value from numbering element
// Labels can only ever be text
// storage for the multiple label numberings used across all cards
var CARD_LABEL_NUMBERING = {};
function handleCardLabelNumber(label, number) {
// Handle the cases where label is
// - empty - we don't want a label
// - undefined - we want the default label
// ensure label is empty HTML (incl as empty)
trimLabel = cleanTrimHtml(label);
if (trimLabel === "") {
// return no label or number if the label is empty (but defined)
return ["", ""];
} else if (typeof number !== "undefined" && number.match(/none/i)) {
// if there is a card number and it is the word "none", then
// return the label and an empty number
// TODO, should this be label of trimLabel. i.e allow user defined
// html to be included as part of the label?
return [label, ""];
} else if (typeof label === "undefined") {
// set the label to the DEFAULT if no label specified
// numbering gets decided below.
trimLabel = DEFAULT_CARD_LABEL;
label = DEFAULT_CARD_LABEL;
}
// Update the numbering schemes
// - no existing numbering, set to 1
// - otherwise increment existing
if (!(trimLabel in CARD_LABEL_NUMBERING)) {
CARD_LABEL_NUMBERING[trimLabel] = 1;
} else {
// if it does exist increment to next value
CARD_LABEL_NUMBERING[trimLabel] += 1;
}
// if specific number specified, set numbering to that
if (typeof number !== "undefined") {
CARD_LABEL_NUMBERING[trimLabel] = parseInt(number);
}
return [label, CARD_LABEL_NUMBERING[trimLabel]];
}
//--------------------------------
// extractCardsFromContent( myCard)
// - given an array of cards (HTML) convert into a reasonabl edatastructure
function extractCardsFromContent(myCards) {
let items = [];
// reset card numbering
CARD_LABEL_NUMBERING = {};
// Loop through each card and construct the items array with card data
myCards.each(function (idx) {
// jQuery(this) - is the vtbgenerated div for a BbItem
//------- check for any review status element
review = getReviewStatus(this);
// Parse the description and remove the Card Image data
// vtbegenerated_div is specific to Blackboard.
// But it also appears to change all
with a class to div with
// the match class, hence the not[class] selector
jQuery(this)
.children('div.vtbegenerated_div,div:not([class=""])')
.replaceWith(function () {
return jQuery("
", { html: jQuery(this).html() });
});
var description = jQuery(this).html();
// - get rid of any inserted by Bb
description = description.replace(/ /gi, " ");
description = description.replace(/\n/gi, "");
// extract all the possible meta data
let cardMetaData = extractCardMetaData(this);
// now have cardMetaData with all meta data and the non meta data
// description. Need to make the necessary changes based on data
// loop through each of the elements (but not description)
// tmp variables used to hold results before putting into single card object
let bgSize = "",
dateLabel = "Commencing",
engageLabel = "",
picUrl,
cardBGcolour,
cardImageBGColour = undefined;
let label = DEFAULT_CARD_LABEL,
activePicUrl = "",
number = " ",
iframe = "";
let date,
comingSoon,
comingSoonLabel = "Available";
let assessmentType = "",
assessmentWeighting = "",
assessmentOutcomes = "";
for (let index in cardMetaData) {
switch (index) {
case "card image background":
cardImageBGColour = identifyCardBackgroundColour(cardMetaData[index]);
break;
case "card image":
[picUrl, cardBGcolour] = handleCardImage(cardMetaData[index]);
break;
case "card image active":
[activePicUrl, cardBGcolour] = handleCardImage(cardMetaData[index]);
break;
case "card image iframe":
iframe = handleCardImageIframe(cardMetaData[index]);
break;
case "card image size":
bgSize = handleCardImageSize(cardMetaData[index]);
break;
case "card date":
date = handleCardDate(cardMetaData[index]);
break;
case "card date label":
dateLabel = cardMetaData[index];
break;
case "card engage":
engageLabel = cardMetaData[index];
break;
case "card coming soon":
comingSoon = handleCardDate(cardMetaData[index]);
break;
case "card coming soon label":
comingSoonLabel = cardMetaData[index];
break;
case "assessment type":
assessmentType = cardMetaData[index];
break;
case "assessment weighting":
assessmentWeighting = cardMetaData[index];
break;
case "assessment outcomes":
assessmentOutcomes = cardMetaData[index];
break;
}
}
// handle card label and card number together
[label, number] = handleCardLabelNumber(
cardMetaData["card label"],
cardMetaData["card number"]
);
// description changed to remove all the meta data
description = cardMetaData["description"];
// TODO is this still used?
// Find any ItemDetailsHeaders that indicate the item is hidden
hidden = jQuery(this)
.parent()
.find(".contextItemDetailsHeaders")
.filter(":contains('Item is hidden from students.')");
//.siblings('contextItemDetailsHeaders')
// Grab the link that the card is pointing to
// need to get back to the header which is up one div, a sibling, then span
var header = jQuery(this).parent().siblings(".item").find("span")[2];
var title = jQuery(header).html(),
link,
linkTarget = "";
//--------------------------------
// Three options for link
// 1. A link on the header (e.g. content folder)
// 2. No link (e.g. a content item)
// 3. A link in the attached filed (content item with attached file)
// This one is kludgy. e.g. doesn't handle multiple files.
// Currently sets the link to the last file
// TODO figure out what do with multiple files
link = jQuery(header).parents("a").attr("href");
linkTarget = jQuery(header).parents("a").attr("target");
// if link is empty, must be content item
if (link === undefined) {
// check to see if there are attached fileds
filesThere = jQuery(this)
.parent()
.find(".contextItemDetailsHeaders")
.filter(":contains('Attached Files:')");
if (filesThere !== undefined) {
// get a list of all attached files
lis = jQuery(this)
.parent()
.find(".contextItemDetailsHeaders")
.children(".detailsValue")
.children("ul")
.children("li");
// loop through the files and get the link
lis.each(function (idx, li) {
// get the link
link = jQuery(li).children("a").attr("href");
});
}
//.siblings('contextItemDetailsHeaders')
}
// get the itemId to allow for "edit" link in card
var itemId = jQuery(this).parents(".liItem").attr("id");
// Hide the contentItem TODO Only do this if display page
var tweak_bb_active_url_pattern = "listContent.jsp";
if (location.href.indexOf(tweak_bb_active_url_pattern) > 0) {
// TODO un comment this Reviewed
jQuery(this).parent().parent().hide();
//console.log( "content item " + contentItem.html());
}
if (typeof cardImageBGColour !== "undefined") {
cardBGcolour = cardImageBGColour;
}
// save the item for later
var item = {
title: title,
picUrl: picUrl,
bgSize: bgSize,
cardBGcolour: cardBGcolour,
description: description,
date: date,
label: label,
link: link,
linkTarget: linkTarget,
review: review,
dateLabel: dateLabel,
engageLabel: engageLabel,
id: itemId,
activePicUrl: activePicUrl,
comingSoon: comingSoon,
comingSoonLabel: comingSoonLabel,
assessmentWeighting: assessmentWeighting,
assessmentOutcomes: assessmentOutcomes,
assessmentType: assessmentType,
};
if (number !== "x") {
item.moduleNum = number;
}
if (iframe !== "") {
item.iframe = iframe;
}
// only add the card to display if
// - VIEW MODE is on and it's not hidden
// - EDIT MODE is on
if (hidden.length === 0 || LOCATION < 0) {
// add message that item is hidden to students when EDIT mode on
if (hidden.length === 1) {
item.description = item.description.concat(HIDDEN_FROM_STUDENTS);
}
items.push(item);
}
});
//console.log(items);
return items;
}
/**
* @function removeBlackboardIcon
* @param {Object} cardInterface jQuery object for where the card interface will go
* @description If exists, update cardInterface to remove Blackboard icon
*/
function removeBlackboardIcon(cardInterface) {
let container = jQuery(cardInterface).parent().parent();
// hide the icon
let icon = jQuery(container).find("img.item_icon").css("display", "none");
// update the padding on the div
let div = jQuery(container).find("div.details").css("padding-left", "10px");
}
/****
* addCardInterface( cardInterface, items )
* - Given an array of items to translate into cards add the HTML etc
* to generate the card interface
* - add it to cardInterface element
*
*/
function addCardInterface(cardInterface, items) {
// Define which template to use
let template = HORIZONTAL;
let linkTemplate = HORIZONTAL;
let engageVerb = "Engage";
// Define the text for Review Status
let MARK_REVIEWED = "Mark Reviewed";
let REVIEWED = "Reviewed";
let NO_CARD_NUMBER = false;
let NO_COMING_SOON = false;
if (cardInterface.length === 0) {
console.log(
"Card: Can't find item with heading 'Card Interface' in which to insert card interface"
);
return false;
} else {
// get the title - text only, stripped of whitespace before/after
var cardInterfaceTitle = jQuery.trim(cardInterface.text());
//Extract parameters
var m = cardInterfaceTitle.match(/Card Interface *([^<]*)/i);
var WIDTH = "md:w-1/3";
if (m) {
newParams = parse_parameters(m[1]);
if (newParams) {
newParams.forEach(function (element) {
m = element.match(/template=["']vertical['"]/i);
m1 = element.match(/template=vertical/i);
if (m || m1) {
template = VERTICAL;
} else if (element.match(/template=['"]horizontal['"]/i)) {
template = HORIZONTAL;
} else if (element.match(/nocardnumber/i)) {
NO_CARD_NUMBER = true;
} else if (element.match(/nocomingsoon/i)) {
NO_COMING_SOON = true;
} else if (element.match(/noimages/i)) {
HIDE_IMAGES = true;
} else if ((x = element.match(/template=by([2-6])/i))) {
WIDTH = "md:w-1/" + x[1];
} else if ((x = element.match(/by([2-6])/i))) {
WIDTH = "md:w-1/" + x[1];
} else if ((x = element.match(/[Bb][yY]1/))) {
WIDTH = "md:w-full";
} else if (element.match(/people/i)) {
template = PEOPLE;
} else if (element.match(/noengage/i)) {
linkTemplate = HORIZONTAL_NOENGAGE;
} else if (element.match(/logging/i)) {
LOGGING = true;
} else if ((m = element.match(/engage=([^']*)/))) {
engageVerb = m[1];
} else if ((m = element.match(/template=assessment/i))) {
template = ASSESSMENT;
} else if ((m = element.match(/set[Dd]ate=([^\s]*)/))) {
SET_DATE = m[1];
} else if ((m = element.match(/^reviewed=([^']*)/iu))) {
REVIEWED = m[1];
} else if ((m = element.match(/^markReviewed=(.+)/i))) {
MARK_REVIEWED = m[1];
} else if ((m = element.match(/^downloadButtonLabel=(.+)/i))) {
DOWNLOAD_LABEL = m[1];
}
});
}
} // if no match, stay with default
}
// console.log("LOGGING IS " + LOGGING);
// make the h3 for the Card Interface item disappear
// (Can't hide the parent as then you can't edit via Bb)
// Need to have the span in order to be able to reorder
cardInterface.html('');
// Get the content area in which to insert the HTML
var firstItem = cardInterface.parent().siblings(".details");
// Use the card HTML template and the data in items to generate
// HTML for each card
var cards = "";
var moduleNum = 1;
items.forEach(function (idx) {
let cardHtml = cardHtmlTemplate[template];
let linkHtml = linkItemHtmlTemplate[linkTemplate];
// coming soon
// By default comingSoon is empty
let comingSoon = "";
// TODO need to only display this if outside the date
if (typeof idx.comingSoon !== "undefined" && !NO_COMING_SOON) {
if (!inDateRange(idx.comingSoon, false)) {
// we have coming soon and NOT in the available date range
// generate the html
comingSoon = generateDateHtml(
comingSoonHtmlTemplate[template],
dualComingSoonHtmlTemplate[template],
idx.comingSoon,
true
);
comingSoon = comingSoon.replace(
"{COMING_SOON_LABEL}",
idx.comingSoonLabel
);
// if students are viewing remove the link stuff
if (window.tweak_bb.display_view) {
// don't show an engage button
linkHtml = "";
// remove the clickableCard link and hover shadow
cardHtml = cardHtml
.replace("clickablecard", "")
.replace("hover:outline-none hover:shadow-outline ", "");
}
}
}
cardHtml = cardHtml.replace("{COMING_SOON}", comingSoon);
// TODO either here, or above in the link section need to remove
// the link
cardHtml = cardHtml.replace("{WIDTH}", WIDTH);
// replace the default background colour if a different one
// is specific
if (idx.cardBGcolour) {
cardHtml = cardHtml.replace(
/background-color:\s*rgb\(255,255,255\)/i,
"background-color: " + idx.cardBGcolour
);
}
//
{IFRAME}
// replace the Engage verb
//---------------------------------------------
// Add in the mark review/reviewed options
var reviewTemplate = "";
if (idx.review !== undefined) {
// only do it if there is a review option found
// check whether its a mark review or review
// - if link contains markUnreviewed then it has been
// reviewed
if (idx.review.match(/markUnreviewed/)) {
reviewTemplate = markUnReviewedLinkHtmlTemplate[template];
reviewTemplate = reviewTemplate.replace("{REVIEWED}", REVIEWED);
} else {
// it's the other one which indicates it has not been reviewed
reviewTemplate = markReviewLinkHtmlTemplate[template];
reviewTemplate = reviewTemplate.replace(
"{MARK_REVIEWED}",
MARK_REVIEWED
);
}
// set the right link
reviewTemplate = reviewTemplate.replace("{LINK}", idx.review);
}
cardHtml = cardHtml.replace("{REVIEW_ITEM}", reviewTemplate);
//console.log("template is " + template);
// Only show module number if there's a label
if (idx.label !== "") {
var checkForNum = idx.moduleNum;
if (NO_CARD_NUMBER) {
// global setting not to show card numbers
cardHtml = cardHtml.replace("{MODULE_NUM}", "");
checkForNum = "";
} else if (idx.moduleNum) {
// if there's a hard coded moduleNum use that
cardHtml = cardHtml.replace("{MODULE_NUM}", idx.moduleNum);
} else {
// use the one we're calculating
//cardHtml = cardHtml.replace('{MODULE_NUM}',moduleNum);
cardHtml = cardHtml.replace(/\{MODULE_NUM\}/g, idx.moduleNum);
// checkForNum probably not required
checkForNum = idx.moduleNum;
}
// Update the title, check to see if it starts with label and
// moduleNum. If it does, remove them from the title
// So that the card doesn't duplicate it, but the information is
// still there in Blackboard
var regex = new RegExp(
"^" + idx.label.trim() + "\\s*" + checkForNum + "\\s*[-:]*\\s*(.*)",
"s"
);
//const regex = /^Week\s*1\s*[-:]*\s*(.*)/gs;
var m = idx.title.match(regex);
//var m = regex.test(idx.title);
if (m) {
idx.title = m[1];
// kludge for COM14 which has a after label in title
idx.title = idx.title.replace(/^/i, "");
}
} else {
cardHtml = cardHtml.replace("{MODULE_NUM}", "");
}
cardHtml = cardHtml.replace("{LABEL}", idx.label);
//------------------ set the card image
// Two options for BG_SIZE
// 1. cover (bg-cover)
// Default option. Image covers the entire backgroun
// 2. contain (bg-contain bg-no-repeat)
// Entire image must fit within the card
if (idx.bgSize === "contain") {
cardHtml = cardHtml.replace(
/{BG_SIZE}/,
"bg-contain bg-no-repeat bg-center"
);
} else {
cardHtml = cardHtml.replace(/{BG_SIZE}/, "bg-cover");
}
// figure out which image we're going to show
var picUrl = setImage(idx);
// replace the {IMAGE_URL} variable if none set
if (!idx.hasOwnProperty("iframe")) {
cardHtml = cardHtml.replace(/{IFRAME}/g, "");
} else {
cardHtml = cardHtml.replace(/{IFRAME}/g, idx.iframe);
// set pic URl to empty so non is provided
picUrl = "";
}
cardHtml = cardHtml.replace(/{PIC_URL}/g, picUrl);
cardHtml = cardHtml.replace("{TITLE}", idx.title);
cardHtml = cardHtml.replace(/\{ASSESSMENT[_ ]TYPE\}/g, idx.assessmentType);
cardHtml = cardHtml.replace(/\{WEIGHTING\}/g, idx.assessmentWeighting);
cardHtml = cardHtml.replace(
/\{LEARNING_OUTCOMES\}/g,
idx.assessmentOutcomes
);
// Get rid of some crud Bb inserts into the HTML
description = idx.description.replace(/
';
cardHtml = cardHtml.replace(/{EDIT_ITEM}/, editLink);
}
// standard date
let date = "";
date = generateDateHtml(
dateHtmlTemplate[template],
dualDateHtmlTemplate[template],
idx.date
);
date = date.replace("{DATE_LABEL}", idx.dateLabel);
cardHtml = cardHtml.replace("{DATE}", date);
// add the individual card html to the collection
cards = cards.concat(cardHtml);
});
// STick the cards into the complete card HTML
var interfaceHtml = interfaceHtmlTemplate[template];
interfaceHtml = interfaceHtml.replace("{CARDS}", cards);
// Insert the HTML to the selected item(s)
//return false;
jQuery(firstItem).append(interfaceHtml);
}
/**
* @function to12
* @param {String} t 24 hour
* @returns {String} time converted to 12 hour with am/pm
*/
function to12(t) {
if (typeof t === "undefined") {
return "";
}
// break home and set hh, m
const regex = /^\s*([0-9]|0[0-9]|1[0-9]|2[0-3]):([0-5][0-9])\s*/;
let m = t.match(regex);
// we have a 24 hour time, convert it
if (m) {
let h,
hh,
mins,
dd = "AM";
hh = parseInt(m[1]);
mins = parseInt(m[2]);
h = hh;
// set PM
if (h >= 12) {
h = hh - 12;
dd = "PM";
}
if (h == 0) {
h = 12;
}
if (mins < 10) {
mins = `0${mins}`;
}
return `${h}:${mins} ${dd}`;
}
// not a 24 hour time show nothing
return "";
}
/**
* @function generateDateHtml
* @params singleTemplate {String} HTML for a single date
* @params dualTemplate {String} HTML for a dual date
* @params date {Object} the date data structure
* @params comingSoon {Boolean} indicate if it's a comingSoon date
* @description parse the date object and use the correct template to
* construct date html to be added to the card
*/
function generateDateHtml(
singleTemplate,
dualTemplate,
date,
comingSoon = false
) {
// by default no html
let cardHtml = "";
if (
typeof date !== "undefined" &&
typeof date.start !== "undefined" &&
"month" in date.start
) {
// Do we have dual dates - both start and stop?
if (date.stop.month ) {
// start and stop dates
//cardHtml = cardHtml.replace('{DATE}', dualDateHtmlTemplate[template]);
cardHtml = dualTemplate;
cardHtml = cardHtml.replace(/{MONTH_START}/g, date.start.month);
cardHtml = cardHtml.replace(/{DATE_START}/g, date.start.date);
cardHtml = cardHtml.replace(/{MONTH_STOP}/g, date.stop.month);
cardHtml = cardHtml.replace(/{DATE_STOP}/g, date.stop.date);
cardHtml = cardHtml.replace(/{TIME_STOP}/g, to12(date.stop.time));
cardHtml = cardHtml.replace(/{TIME_START}/g, to12(date.start.time));
//-- handle the {WEEK} variable for dual dates
if (!date.start.hasOwnProperty("week")) {
// no start week, so week is empty
cardHtml = cardHtml.replace("{WEEK}", "");
} else {
// if exam, use that template
// other wise construct dual week
let weekHtml = examPeriodTemplate;
if (date.start.week !== "exam") {
// not exam, then set to dualWeekHtml
if ( date.start.week!==date.stop.week) {
weekHtml = dualWeekHtmlTemplate.replace(
"{WEEK_START}", date.start.week);
weekHtml = weekHtml.replace("{WEEK_STOP}", date.stop.week);
} else {
// same week, so using single week template
weekHtml = weekHtmlTemplate.replace("{WEEK}", `Week ${date.start.week}`);
}
}
cardHtml = cardHtml.replace("{WEEK}", weekHtml);
}
// handle the {TIME} variable for dual dates
const defaultStartTime = date.start.time === "0:01";
const defaultStopTime = date.stop.time === "23:59";
if (defaultStartTime && defaultStopTime) {
// default time just remove {TIME}
cardHtml = cardHtml.replace("{TIME}", "");
} else {
// show the non default time
let timeHtml = dualTimeHtmlTemplate;
timeHtml = timeHtml.replace("{TIME_START}", to12(date.start.time));
timeHtml = timeHtml.replace("{TIME_STOP}", to12(date.stop.time));
cardHtml = cardHtml.replace("{TIME}", timeHtml);
}
// handle the specific days for dual dates
const startDay = "day" in date.start;
const stopDay = "day" in date.stop;
if ((!startDay && !stopDay) || (!startDay && date.stop.day === "Fri")) {
// no specific days, don't add days
cardHtml = cardHtml.replace("{DAYS}", "");
} else {
// at least one specific day
let dayHtml = dualDayHtmlTemplate;
if (startDay) {
dayHtml = dayHtml.replace("{DAY_START}", date.start.day);
} else {
dayHtml = dayHtml.replace("{DAY_START}", "Mon");
}
if (stopDay) {
dayHtml = dayHtml.replace("{DAY_STOP}", date.stop.day);
} else {
dayHtml = dayHtml.replace("{DAY_STOP}", "Fri");
}
cardHtml = cardHtml.replace("{DAYS}", dayHtml);
}
} else {
// just start date
//cardHtml = cardHtml.replace('{DATE}', dateHtmlTemplate[template]);
cardHtml = singleTemplate;
cardHtml = cardHtml.replace(/{MONTH}/g, date.start.month);
cardHtml = cardHtml.replace(/{DATE}/g, date.start.date);
// not yet
// cardHtml = cardHtml.replace(/{TIME}/g, to12(date.start.time));
// cardHtml = cardHtml.replace(/{DATE_LABEL}/g, idx.dateLabel);
if (!date.start.hasOwnProperty("week")) {
cardHtml = cardHtml.replace("{WEEK}", "");
} else {
// SKETCHY TODO change added block around else
let weekReplace = "Week " + date.start.week;
if ("day" in date.start) {
weekReplace = date.start.day + " " + weekReplace;
}
let weekHtml = weekHtmlTemplate.replace("{WEEK}", weekReplace);
cardHtml = cardHtml.replace("{WEEK}", weekHtml);
}
// handle the {TIME} variable for single date
if ("time" in date.start) {
// comingSoon dates include the default time
if (!comingSoon && date.start.time === "0:01") {
// default time just remove {TIME}
cardHtml = cardHtml.replace("{TIME}", "");
} else {
// show the non default time
if (!comingSoon) {
let timeHtml = timeHtmlTemplate;
timeHtml = timeHtml.replace("{TIME_START}", to12(date.start.time));
cardHtml = cardHtml.replace("{TIME}", timeHtml);
} else {
cardHtml = cardHtml.replace("{TIME}", to12(date.start.time));
}
}
}
}
}
return cardHtml;
}
/**
* @function inDateRange
* @param cardDate {Object} card.date object
* @param assumeStop {Boolean} true if assuming a stop date if one not specified
* @returns {Boolean} true if the current time (or SET_DATE) is within the
* date range
*/
function inDateRange(cardDate, assumeStop = true) {
if (typeof cardDate !== "undefined") {
let start, stop, now;
// Set now to current date OR SET_DATE if we want to do testing
if (SET_DATE === "") {
now = new Date();
} else {
now = new Date(SET_DATE);
}
// set the start date
if (cardDate.start.hasOwnProperty("month") && cardDate.start.month !== "") {
start = convertToDate(cardDate.start);
}
// set the card stop date
// - to card.date.stop if valid
// - to the end of the week if using a week
// - to the end of the day if no stop
if (cardDate.stop.hasOwnProperty("month") && cardDate.stop.month !== "") {
if (cardDate.stop.time === "") {
cardDate.stop.time = "23:59";
}
stop = convertToDate(cardDate.stop);
} else if (
cardDate.start.hasOwnProperty("week") &&
cardDate.start.week !== ""
) {
// there's no end date, but there is a start week
// so set stop to end of that week, but only if inWeek is true
if (cardDate.start.week in TERM_DATES[TERM]) {
if (assumeStop) {
stop = new Date(TERM_DATES[TERM][cardDate.start.week].stop);
stop.setHours(23, 59, 0);
}
} else {
// problem with week, just set it to end of date
if (typeof start !== "undefined" && assumeStop) {
stop = new Date(start.getTime());
stop.setHours(23, 59, 0);
}
}
/* } else { // no week for stop, meaning it's just on the day
stop = new Date(start.getTime());
stop.setHours(23, 59, 0); */
}
// figure out if we're in range
if (typeof stop !== "undefined") {
// if stop defined, check in range
return now >= start && now <= stop;
} else {
// check passed start
return now >= start;
}
}
return false;
}
/**
* @function convertToDate
* @param {Object} dateObj
* @returns {Date} Javascript date object
* Converts the simple date object into a Javascript date object
*/
function convertToDate(dateObj) {
// check for valid month??
let date = new Date(
dateObj.year,
MONTHS_HASH[dateObj.month],
parseInt(dateObj.date)
);
// if time set time
if ("time" in dateObj && dateObj.time !== "") {
// split into hours minutes
let m = dateObj.time.match(
/^\s*([0-9]|0[0-9]|1[0-9]|2[0-3]):([0-5][0-9])\s*/
);
if (m) {
date.setHours(m[1], m[2], 0);
}
}
return date;
}
//*********************
// getTermDate( week, day )
// - given a week of Griffith semester return date for the
// start of that week
// - optional pass day of the week, add more days Monday=0
function getTermDate(week, startWeek = true, dayOfWeek = "Monday") {
if (typeof TERM_DATES[TERM] === "undefined") {
return undefined;
}
dayOfWeek = dayOfWeek.toLowerCase();
//console.log("TERM is " + TERM + " week is " + week);
var date = { date: "", month: "", week: week, year: 0 };
if (week < 0 || week > 15) {
if (week !== "exam") {
return date;
}
}
var start;
if (startWeek === true) {
// setting start week
if (typeof TERM_DATES[TERM][week] !== "undefined") {
start = TERM_DATES[TERM][week].start; //[week].start;
}
} else {
start = TERM_DATES[TERM][week].stop;
}
var d = new Date(start);
// if dayOfWeek is not Monday, add some days
if (dayOfWeek !== "monday") {
var dayToNum = {
tuesday: 1,
tue: 1,
wednesday: 2,
wed: 2,
thursday: 3,
thu: 3,
friday: 4,
fri: 4,
saturday: 5,
sat: 5,
sunday: 6,
sun: 6,
};
// add in the day abbreviation so it can appear
date.day = dayOfWeek.charAt(0).toUpperCase() + dayOfWeek.substr(1, 2);
if (dayOfWeek in dayToNum) {
d.setDate(d.getDate() + dayToNum[dayOfWeek.toLowerCase()]);
}
}
date.month = MONTHS[d.getMonth()];
date.date = d.getDate();
date.year = d.getFullYear();
return date;
}
//*************************************************************
// picUrl = setImage( card )
// - given card object containing information about a card
// - return picUrl if no active card image
// - return picUrl if there is an active card image, but it's
// not the date
// - return activePicUrl if there is one and it's not the date
function setImage(card) {
// only use activePicURL if it is set and there are dates on
// the card
if (card.activePicUrl !== "" && typeof card.date !== "undefined") {
// there is an activePicUrl, check if it should be active
// active means that the current date falls within the start/stop
// dates for the card
var start, stop, now;
// Set now to current date OR SET_DATE if we want to do testing
if (SET_DATE === "") {
now = new Date();
} else {
now = new Date(SET_DATE);
}
// set the start date
if (
card.date.start.hasOwnProperty("month") &&
card.date.start.month !== ""
) {
start = new Date(
parseInt(DEFAULT_YEAR),
//MONTHS.indexOf(card.date.start.month),
MONTHS_HASH[card.date.start.month],
parseInt(card.date.start.date)
);
}
// set the card stop date
// - to card.date.stop if valid
// - to the end of the week if using a week
// - to the end of the day if no stop
if (card.date.stop.hasOwnProperty("month") && card.date.stop.month !== "") {
stop = new Date(
DEFAULT_YEAR,
MONTHS_HASH[card.date.stop.month],
card.date.stop.date
);
stop.setHours(23, 59, 0);
} else if (card.date.start.hasOwnProperty("week")) {
// there's no end date, but there is a start week
// so set stop to end of that week
if (card.date.start.week in TERM_DATES[TERM]) {
stop = new Date(TERM_DATES[TERM][card.date.start.week].stop);
stop.setHours(23, 59, 0);
} else {
// problem with week, just set it to end of date
if (typeof start !== "undefined") {
stop = new Date(start.getTime());
stop.setHours(23, 59, 0);
}
}
} else {
// no week for stop, meaning it's just on the day
stop = new Date(start.getTime());
stop.setHours(23, 59, 0);
}
if (now >= start && now <= stop) {
return card.activePicUrl;
}
}
return card.picUrl;
}
//**************************************************************
// cardBGcolour = identifyCardBackgroundColour( value );
// return undefined if value is not a valid CSS colour
// Otherwise return rgb(X,Y,Z)
function identifyCardBackgroundColour(input) {
// don't both if it's an empty string or a URL (or relative URL)
url = input.match(/^\s*http/i) || input.match(/^\//);
if (input === "" || url) {
return undefined;
}
var div = document.createElement("div"),
m;
div.style.color = input;
// add to DOMTree to work
document.body.appendChild(div);
// extract the rgb numbers
m = getComputedStyle(div).color.match(
/^rgb\s*\(\s*(\d+)\s*,\s*(\d+)\s*,\s*(\d+)\s*\)$/i
);
if (m) {
return "rgb(" + m[1] + "," + m[2] + "," + m[3] + ")";
}
return undefined;
}
//**************************************************************
// picUrl = identifyPicUrl( value )
// TODO - return "" if value is not a valid URI
// Otherwise return the value
function identifyPicUrl(value) {
let re = new RegExp(/img[^>]*src="([^"]*)"/, "i");
let m = value.match(re);
// found an image
if (m) {
// not a BBIMG, then return it
if (!m[1].includes(BBIMG)) {
return m[1];
}
// is a BBIMG try extract the link
// kludge because I couldn't get registers to work in JS REs
re = new RegExp(/([^>]*)<\/a>/, "i");
m = value.match(re);
if (m) {
if (m[1] === m[2]) {
return m[1];
}
}
}
// is there a link to the image
re = new RegExp('href="([^"]*)', "i");
m = value.match(re);
// if it's a return the picUrl
if (m) {
return m[1];
}
// remove all html and just use the text content that's left
let tmp = document.createElement("DIV");
tmp.innerHTML = value;
value = tmp.textContent || tmp.innerText || "";
// must be just a lone URL TODO check it actually does
return value;
}
//-----------------------------------------------------------------
// getReviewStatus
// - given a vtbgenerated item from Bb Item, check to see if the
// parent div contains a review status element (anchor with class
// button-5)
// - if not return NULL
// - if there is one return the link (which indicates with it's
// mark reviewed, or reviewed)
function getReviewStatus(vtbgen) {
// get parent
var parent = jQuery(vtbgen).parent();
// check to see if it has the anchor with class button-5
review = jQuery(parent).find("a.button-5");
if (review.length === 0) {
return undefined;
} else {
return jQuery(review).attr("href");
}
}
//---------------------------------------------------------------------
// Given a string of parameters use some Stack Overflow provided
// regular expression magic to split it up into its component parts
function parse_parameters(cmdline) {
// var re_next_arg = /^\s*((?:(?:"(?:\\.|[^"])*")|(?:'[^']*')|\\.|\S)+)\s*(.*)$/;
let re_next_arg = /^\s*((?:(?:"(?:\\.|[^"])*")|(?:'[^']*')|\\.|\S)+)\s*(.*)$/;
let next_arg = ["", "", cmdline];
let args = [];
while ((next_arg = re_next_arg.exec(next_arg[2]))) {
let quoted_arg = next_arg[1];
let unquoted_arg = "";
while (quoted_arg.length > 0) {
if (/^"/.test(quoted_arg)) {
let quoted_part = /^"((?:\\.|[^"])*)"(.*)$/.exec(quoted_arg);
unquoted_arg += quoted_part[1].replace(/\\(.)/g, "$1");
quoted_arg = quoted_part[2];
} else if (/^'/.test(quoted_arg)) {
let quoted_part = /^'([^']*)'(.*)$/.exec(quoted_arg);
unquoted_arg += quoted_part[1];
quoted_arg = quoted_part[2];
} else if (/^\\/.test(quoted_arg)) {
unquoted_arg += quoted_arg[1];
quoted_arg = quoted_arg.substring(2);
} else {
unquoted_arg += quoted_arg[0];
quoted_arg = quoted_arg.substring(1);
}
}
args[args.length] = unquoted_arg;
}
return args;
}
/****
* function addExpandPrintButtons
* - add buttons (only downloadButton) to top of card interface
* - adapted from similar for Content Interface
*/
function addButtons() {
// jQuery("#GU_ContentInterface").prepend(EXPAND_COLLAPSE_BUTTON_HTML);
// show downloadButton for downloadButtonURL and downloadButtonLabel
if (PARAMS.downloadButtonURL) {
let tooltip = "";
let tt_class = "";
if (PARAMS.downloadButtonTip) {
tooltip = `data-tooltip-content="${PARAMS.downloadButtonTip}"`;
tt_class = 'class="ci-tooltip"';
addToolTipster(); // ** where's this
}
const download_button = `
`;
// add the expand buttons - only Content Interface
// insert before #guCardInterface
let buttonDiv = document.createElement("div");
buttonDiv.id = "guCardButtons";
buttonDiv.style.paddingBottom="1em";
let cardInterface = document.getElementById("guCardInterface");
cardInterface.parentElement.insertBefore(buttonDiv,cardInterface)
buttonDiv.insertAdjacentHTML('beforeend',download_button);
// jQuery("div#guCardButtons").prepend(download_button);
return true;
}
}
/************************************************
* checkParams
* - given the card interfaace element check for paraemters
* - set object attributes and return it
* - parameters come from both
* - the title of the Content Interface content item
* - a Web Link content item that has Content Document in the title
*/
function checkParams(cardInterface) {
var paramsObj = {};
// checking parameters in the card interface title is done elsewhere
/**********
* * check other content items for other parameters that are Content Items
* - Only look for those defined in global ITEM_LINK_PARAMETERS
* - Looking for the link associated with item, what they are pointing to
* - ITEM_PARAMS defines
* - key - is the expected title of the Blackboard item
* - element - define attribute name to add to paramsObj to contain jQuery element
* to find in the Blackboard item
* - item - define pramsObj attribute name for the actual value
*/
let ITEM_LINK_PARAMETERS = {
downloadButtonURL: {
element: "downloadButtonElement",
item: "downloadButtonURL",
},
downloadButtonTip: {
element: "downloadButtonTipElement",
item: "downloadButtonTip",
type: "contentItem",
},
};
for (let paramKey in ITEM_LINK_PARAMETERS) {
const obj = ITEM_LINK_PARAMETERS[paramKey];
// element is the h3 wrapped around the link
element = jQuery(tweak_bb.page_id + " > " + tweak_bb.row_element)
.find(".item h3")
.filter(':contains("' + paramKey + '")')
.eq(0);
// only if it's found
if (element.length > 0) {
paramsObj[obj.element] = element;
// the type of content, depends on the type
if (obj.type === "contentItem") {
// content is element.parent.sibling(div.details)
// and then remove all the vtbgenertedt_div crap
let tipContent = jQuery(paramsObj[obj.element])
.parent()
.next("div.details")
.html();
tipContent = tipContent.replace(/class="vtbegenerated_div"/g, "");
tipContent = tipContent.replace(/class="vtbegenerated"/g, "");
tipContent = tipContent.replace(/(?:\r\n|\r|\n)/g, " ");
paramsObj[obj.item] = tipContent;
} else {
// assume a link item
paramsObj[obj.element] = element;
paramsObj[obj.item] = jQuery(paramsObj[obj.element])
.children("a")
.attr("href");
}
// hide the elements
jQuery(paramsObj[obj.element]).parents("li").hide();
}
}
//console.log(paramsObj);
return paramsObj;
}
/**
* function addToolTipster
* - add the JS for tooltips
*/
function addToolTipster() {
if (!TOOLTIPSTER_ADDED) {
// add tooltipster if there are footnotes
jQuery("head").append(
""
);
getScript(
//"https://cdn.jsdelivr.net/npm/tooltipster@4.2.8/dist/js/tooltipster.bundle.js",
"https://cdn.jsdelivr.net/npm/tooltipster@4.2.8/dist/js/tooltipster.bundle.min.js",
onScriptLoad
);
TOOLTIPSTER_ADDED = true;
}
}
// https://blog.kevinchisholm.com/javascript/jquery-getscript-alternatives/
function getScript(scriptUrl, callback) {
const script = document.createElement('script');
script.src = scriptUrl;
script.onload = callback;
document.body.appendChild(script);
}
function onScriptLoad() {
docWidth = Math.floor(jQuery(document).width() / 2);
jQuery(".ci-tooltip").tooltipster({ maxWidth: docWidth });
}