VuFind
  1. VuFind
  2. VUFIND-1142

OCLC Shutting Down xID (xISBN/xISSN/xOCLCNum) services may affect VuFind

    Details

    • Type: Bug Bug
    • Status: Resolved
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 3.0
    • Component/s: Record
    • Labels:
      None

      Description

      OCLC has announced the end of their xID services, which VuFind uses for linking to related editions on the record view:

      http://www.oclc.org/developer/news/2015/change-to-xid-services.en.html

      We will need to remove this functionality from VuFind, since no successor service has been announced.

      Once the API is offline, VuFind's attempts to access it may cause performance problems and/or errors, especially in early versions (i.e. VuFind 1.x) which had less robust error handling.

      Instructions for disabling the service in earlier versions of VuFind will be posted here as best practices are determined. Please post comments here if you have questions/problems.

        Activity

        Hide
        Demian Katz added a comment - - edited
        To disable xID functionality in VuFind 2.x, just comment out the `related[] = "Editions"` setting in config.ini -- see https://github.com/vufind-org/vufind/blob/v2.5/config/vufind/config.ini#L1090

        If using the WorldCat module, comment out the similar `related[] = "WorldCatEditions"` setting in WorldCat.ini.

        Also watch out for any custom code that relies on the WorldCatUtils class -- https://github.com/vufind-org/vufind/blob/v2.5/module/VuFind/src/VuFind/Connection/WorldCatUtils.php -- though it is fairly unlikely that anyone has created any.
        Show
        Demian Katz added a comment - - edited To disable xID functionality in VuFind 2.x, just comment out the `related[] = "Editions"` setting in config.ini -- see https://github.com/vufind-org/vufind/blob/v2.5/config/vufind/config.ini#L1090 If using the WorldCat module, comment out the similar `related[] = "WorldCatEditions"` setting in WorldCat.ini. Also watch out for any custom code that relies on the WorldCatUtils class -- https://github.com/vufind-org/vufind/blob/v2.5/module/VuFind/src/VuFind/Connection/WorldCatUtils.php -- though it is fairly unlikely that anyone has created any.
        Hide
        Demian Katz added a comment -
        To disable xID functionality in VuFind 1.x, remove references to "editions" in web/services/Record/Record.php. This code will vary from version to version, but here is the final 1.x version:

        https://sourceforge.net/p/vufind/svn/HEAD/tree/trunk/web/services/Record/Record.php#l191

        If you prefer to deal with this at a lower level, you could instead revise web/sys/WorldCatUtils.php to return empty arrays from all of the getX*() methods. See https://sourceforge.net/p/vufind/svn/HEAD/tree/trunk/web/sys/WorldCatUtils.php
        Show
        Demian Katz added a comment - To disable xID functionality in VuFind 1.x, remove references to "editions" in web/services/Record/Record.php. This code will vary from version to version, but here is the final 1.x version: https://sourceforge.net/p/vufind/svn/HEAD/tree/trunk/web/services/Record/Record.php#l191 If you prefer to deal with this at a lower level, you could instead revise web/sys/WorldCatUtils.php to return empty arrays from all of the getX*() methods. See https://sourceforge.net/p/vufind/svn/HEAD/tree/trunk/web/sys/WorldCatUtils.php
        Hide
        Demian Katz added a comment -
        Full removal of xID code from VuFind master took place here: https://github.com/vufind-org/vufind/commit/32cab5d4130fd3cdcf20cec5f81fa109c3a9b4cd
        Show
        Demian Katz added a comment - Full removal of xID code from VuFind master took place here: https://github.com/vufind-org/vufind/commit/32cab5d4130fd3cdcf20cec5f81fa109c3a9b4cd

          People

          • Assignee:
            Demian Katz
            Reporter:
            Demian Katz
          • Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved: