Islandora tokens 1171 #66

wgilling · 2021-04-28T23:02:08Z

GitHub Issue: Islandora/documentation#1171

Other Relevant Links (Google Groups discussion, related pull requests,
Release pull requests, etc.)

What does this Pull Request do?

Consolidates the separate works from ASU and Jonathan Hunt to provide some islandora_tokens.

What's new?

The code from https://github.com/kayakr/islandora_tokens and https://github.com/asulibraries/islandora-repo/tree/develop/web/modules/custom/islandora_tokens were merged into the the controlled_access_terms module.

Any tokens that were created with a previous install should still be supported by the new code (after legacy module is uninstalled and this is installed, for example, a token for [islandoratokens:agent_contributor] would still output the same value afterwards).

How should this be tested?

After pulling in this branch and the cache is cleared, ANY place where you can use tokens should support these tokens, but we used it in the Metatag: Google Scholar in order to provide values for the various scholar meta tags. To use this, first install metatag and metatag_google_scholar and configure the "Repository item" content type admin/config/search/metatag/node__islandora_object to define several of the fields output to use some of the tokens. These should pop up when you click the "Browse available tokens." link -- and are all in the "Islandora Tokens" section.

Interested parties

@Islandora/8-x-committers, @dannylamb, @kayakr

…unt and ASU distinct implements of islandora_tokens modules for #1171

elizoller · 2021-04-28T23:06:29Z

this looks like it would supercede #30

dannylamb · 2021-04-29T13:12:59Z

Beautiful. This will be useful to soooooooo many people.

seth-shaw-unlv · 2021-04-29T16:46:07Z

controlled_access_terms.tokens.inc

+ * @return mixed
+ *   \Drupal\file\FileInterface on success, NULL otherwise.
+ */
+function controlled_access_terms_image_from_media($media) {


We can't rely on Islandora services because this module may be used independently of it.

I would crib from Islandora's Media Source Service for a Drupal solution that supports multiple Media Types (See both https://github.com/Islandora/islandora/blob/8.x-1.x/src/MediaSource/MediaSourceService.php#L121-L133 and https://github.com/Islandora/islandora/blob/8.x-1.x/src/MediaSource/MediaSourceService.php#L97-L107).

I didn't write this part, but I think I can swap out that fixed field-name with the bundle config media type fieldname without breaking it. fingers-crossed.

Or maybe move the chunks for getting files from Media to islandora? Hacking out the particular files seems very Islandora specific. Presumably if you were running controlled_access_terms without Islandora, you wouldn't need to jump through the same hoops to get your pdf or thumbnail.

ok - this makes sense... I can make those changes... so, I infer that there would need to be synchronized pull requests after this so that islandora as well as controlled_access_terms are both updated with the whole set of tokens functionality.

Should I just make note of this in both pull requests' descriptions (that there is a related pull request on the other module)?

wgilling · 2021-05-03T15:42:00Z

Ok -- a new branch with the same exact name was made in our fork of the islandora code repository and a similar pull request has been made for that to split out the Media calls from here controlled_access_terms and move it into islandora.

dannylamb · 2021-05-03T15:49:52Z

🙇

kayakr · 2021-05-13T03:20:27Z

controlled_access_terms.tokens.inc

+
+        case 'media-thumbnail-image:url':
+        case 'media_thumbnail_image:url':
+          $term = $islandoraUtils->getTermForUri('http://pcdm.org/use#ThumbnailImage');


$islandoraUtils doesn't exist here. Needs $islandoraUtils = \Drupal::service('islandora.utils');

kayakr · 2021-05-13T03:25:35Z

controlled_access_terms.tokens.inc

+          $fid[0]['target_id'] : NULL;
+        if (!is_null($fid_value)) {
+          $file = File::load($fid_value);
+          $url = $file->getFileUri();


$url returned here is fedora://filepath. Needs to include overall site domain.

…x to islandoraUtils object variable for #1171

elizoller · 2021-06-08T20:19:25Z

PHPCS is unhappy on this one https://github.com/Islandora/controlled_access_terms/pull/66/checks?check_run_id=2777626305#step:12:13 @wgilling

wgilling · 2021-07-06T23:03:16Z

this should now have all of the phpcs updates and be ready to merge

dannylamb · 2021-07-15T17:08:52Z

controlled_access_terms.tokens.inc

+    'name' => t("PDF Url"),
+    'description' => t('URL to related media file if "Original file" is a PDF file'),
+  ];
+  $node['media-thumbnail-image:url'] = [


media-thumbnail-image:url and media-thumbnail-alt as well as their underscored counterparts can be removed now that they're in the islandora module.

dannylamb · 2021-07-15T17:12:48Z

controlled_access_terms.tokens.inc

+    'name' => t("Publication date"),
+    'description' => t('Show the "Date Created" into YYYY/MM/DD format (handles EDTF format)'),
+  ];
+  $node['pdf_url'] = [


This fella ought to be moved into the islandora module since it does the whole 'media lookup by media_use term' dealio.

This guy still needs to get moved over into the islandora module, or you put a conditional around it to check for the islandora module. At least then it'll be a soft dependency instead of an undeclared hard dependency.

Ok -- this token has now been moved over to the islandora_tokens_1171 branch of the islandora module https://github.com/asulibraries/islandora/tree/islandora_tokens_1171 (as well as renaming the helper function from "controlled_access_terms_*" to lookup the media by mime type).

…ndora tokens file for #1171

…lop values when the delimiter is not a comma for #1171

wgilling · 2021-07-20T20:56:08Z

Ok -- it may be worth it to test out the. code before the metadata patch is appllied... in the event that the configuration for the metadata separation character does not exist, the updated code now assumes to use a comma.
To test the functionality as it will be once the metadata patch is included in the playbook (separate PR that @elizoller is making to the playbook, but it looks like the lines pasted below), this patch will need to be applied. This can be done by editing the /var/www/html/drupal/composer.json file to add a section for this patch:

+            },
+            "drupal/metatag": {
+                "fix for delimiters": "https://git.drupalcode.org/project/metatag/-/merge_requests/20.diff"
            }

... and then run composer update drupal/metadata

Be sure that the previous islandora_tokens module is not installed -- and that the current islandora branch is up to date.

kayakr · 2021-07-20T23:37:55Z

@wgilling Just tried this out on some real data and got an error:

The website encountered an unexpected error. Please try again later.
Error: Call to a member function getFileUri() on null in controlled_access_terms_url_to_service_file_media_by_mimetype() (line 263 of modules/contrib/controlled_access_terms/controlled_access_terms.tokens.inc).

https://github.com/Islandora/controlled_access_terms/pull/66/files#diff-ecff50b0a1ba42fe05498c9dac67f1f04ae584715dad824497951a82c2d045ecR263 assumes File has loaded correctly but in my case it looks like a file has been deleted but the media still (somehow) references it (or the file has failed to load for other reasons). In any case, it would be good to test is_object($file) before getting URL.

wgilling

@wgilling Just tried this out on some real data and got an error:

The website encountered an unexpected error. Please try again later.
Error: Call to a member function getFileUri() on null in controlled_access_terms_url_to_service_file_media_by_mimetype() (line 263 of modules/contrib/controlled_access_terms/controlled_access_terms.tokens.inc).

https://github.com/Islandora/controlled_access_terms/pull/66/files#diff-ecff50b0a1ba42fe05498c9dac67f1f04ae584715dad824497951a82c2d045ecR263 assumes File has loaded correctly but in my case it looks like a file has been deleted but the media still (somehow) references it (or the file has failed to load for other reasons). In any case, it would be good to test is_object($file) before getting URL.

This token has been moved from controlled_access_terms to the islandora module (https://github.com/asulibraries/islandora/tree/islandora_tokens_1171) and the added logic to test whether or not there is a file has been added.

To test, this may be a problem since the previous instance of this token lived in controlled_access_terms and now that logic all exists in islandora (by the same exact token name [islandoratokens:pdf_url], but I believe that clearing the cache will be sufficient to get the code to execute from the new islandora module location.

wgilling · 2021-04-29T16:58:27Z

controlled_access_terms.tokens.inc

+ * @return mixed
+ *   \Drupal\file\FileInterface on success, NULL otherwise.
+ */
+function controlled_access_terms_image_from_media($media) {


I didn't write this part, but I think I can swap out that fixed field-name with the bundle config media type fieldname without breaking it. fingers-crossed.

wgilling · 2021-04-30T16:02:16Z

controlled_access_terms.tokens.inc

+ * @return mixed
+ *   \Drupal\file\FileInterface on success, NULL otherwise.
+ */
+function controlled_access_terms_image_from_media($media) {


ok - this makes sense... I can make those changes... so, I infer that there would need to be synchronized pull requests after this so that islandora as well as controlled_access_terms are both updated with the whole set of tokens functionality.

Should I just make note of this in both pull requests' descriptions (that there is a related pull request on the other module)?

wgilling · 2021-07-21T17:28:20Z

controlled_access_terms.tokens.inc

+    'name' => t("Publication date"),
+    'description' => t('Show the "Date Created" into YYYY/MM/DD format (handles EDTF format)'),
+  ];
+  $node['pdf_url'] = [


Ok -- this token has now been moved over to the islandora_tokens_1171 branch of the islandora module https://github.com/asulibraries/islandora/tree/islandora_tokens_1171 (as well as renaming the helper function from "controlled_access_terms_*" to lookup the media by mime type).

dannylamb

👍

I've tested all these tokens with metatag_google_scholar and they're all working, including using multiple values 🚀

dannylamb · 2021-07-22T20:29:30Z

Well, it was a long and winding road, but we got there @wgilling . If you wanna toss up the PR for the pdf file on islandora I can test and merge real quick.

I'm going to go ahead and slice the version for this module for the release!

Merci beaucoup encore 🙇‍♂️

wgilling added 2 commits April 28, 2021 18:37

tokens info and token hook handler for the merged works of Jonathan H…

defa6c9

…unt and ASU distinct implements of islandora_tokens modules for #1171

moved relevant islandora_tokens code here for #1171

890a16a

seth-shaw-unlv reviewed Apr 29, 2021

View reviewed changes

wgilling added 2 commits April 30, 2021 18:01

moved tokens here from defunct islandora_tokens module

8af389e

added a comment

3fab7ad

wgilling mentioned this pull request May 3, 2021

Islandora tokens? Islandora/documentation#1171

Closed

kayakr reviewed May 13, 2021

View reviewed changes

wgilling added 2 commits May 13, 2021 21:51

added file_create_url() to the media-thumbnail-image:url token, bugfi…

f08d153

…x to islandoraUtils object variable for #1171

bugfix to use D9 friendly file object methods for #1171

f8e3452

kayakr mentioned this pull request May 17, 2021

Define token for linked-agent #30

Closed

phpcs - fixed all warnings and errors for #1171

4d59f90

dannylamb requested changes Jul 15, 2021

View reviewed changes

wgilling added 5 commits July 16, 2021 00:28

removed tokens that are now part of islandora.tokens

acc7f39

localized the function names so they do not collide with code in isla…

2314594

…ndora tokens file for #1171

use the delimiter from the metatag patch if configured -- only flip-f…

087fffc

…lop values when the delimiter is not a comma for #1171

cleanup variable that was not used and comments

87be45e

resolved merge conflicts

5ac469a

wgilling added 2 commits July 21, 2021 17:13

removed the PDF URL token logic and moved to islandora tokens for #1171

d7c4b36

removed unused references to Media and File classes

5aa8c34

wgilling commented Jul 21, 2021

View reviewed changes

dannylamb approved these changes Jul 22, 2021

View reviewed changes

dannylamb merged commit 79b4694 into Islandora:8.x-1.x Jul 22, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Islandora tokens 1171 #66

Islandora tokens 1171 #66

wgilling commented Apr 28, 2021

elizoller commented Apr 28, 2021

dannylamb commented Apr 29, 2021

seth-shaw-unlv Apr 29, 2021 •

edited

Loading

wgilling Apr 29, 2021

dannylamb Apr 30, 2021

wgilling Apr 30, 2021

wgilling commented May 3, 2021

dannylamb commented May 3, 2021

kayakr May 13, 2021

kayakr May 13, 2021

elizoller commented Jun 8, 2021

wgilling commented Jul 6, 2021

dannylamb Jul 15, 2021

dannylamb Jul 15, 2021

dannylamb Jul 21, 2021

wgilling Jul 21, 2021

wgilling commented Jul 20, 2021

kayakr commented Jul 20, 2021

wgilling left a comment

wgilling Apr 29, 2021

wgilling Apr 30, 2021

wgilling Jul 21, 2021

dannylamb left a comment •

edited

Loading

dannylamb commented Jul 22, 2021

Islandora tokens 1171 #66

Islandora tokens 1171 #66

Conversation

wgilling commented Apr 28, 2021

What does this Pull Request do?

What's new?

How should this be tested?

Interested parties

elizoller commented Apr 28, 2021

dannylamb commented Apr 29, 2021

seth-shaw-unlv Apr 29, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wgilling commented May 3, 2021

dannylamb commented May 3, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

elizoller commented Jun 8, 2021

wgilling commented Jul 6, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wgilling commented Jul 20, 2021

kayakr commented Jul 20, 2021

wgilling left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dannylamb left a comment • edited Loading

Choose a reason for hiding this comment

dannylamb commented Jul 22, 2021

seth-shaw-unlv Apr 29, 2021 •

edited

Loading

dannylamb left a comment •

edited

Loading