[Share] Film Tagger - OMDb Metadata Enrichment

[Vaikri-costume]

Description

Convert items to film type and fetch complete metadata from OMDb (Open Movie Database). Adds title, year, runtime, language, plot, directors, cast, IMDb ID, country, genre, and rating.

Event

None

Operation

Script

Data

/**
 * Film Tagger - OMDb Metadata Enrichment
 * Converts items to film type and fetches complete metadata from OMDb
 * @author vaidehikrishnan
 * @usage Right-click item(s) → Film Tagger
 * @link https://github.com/windingwind/zotero-actions-tags/discussions/
 * @see https://www.omdbapi.com/apikey.aspx
 */

// ==== CONFIG ====
const OMDB_API_KEY = "YOUR_API_KEY_HERE"; // Get free key from https://www.omdbapi.com/apikey.aspx

// ==== HELPERS ====
function parseExtra(extra) {
  const map = {};
  if (!extra) return map;
  for (const line of extra.split(/\r?\n/)) {
    const m = line.match(/^([^:]+):\s*(.+)$/);
    if (m) {
      map[m[1].trim()] = m[2].trim();
    }
  }
  return map;
}

function serializeExtra(map) {
  return Object.entries(map)
    .map(([k, v]) => `${k}: ${v}`)
    .join("\n");
}

function getImdbFromExtra(extra) {
  if (!extra) return null;
  const map = parseExtra(extra);
  const candidates = [
    map["IMDb"],
    map["IMDb ID"],
    map["IMDB"],
    map["IMDB ID"],
  ].filter(Boolean);
  if (candidates.length > 0) {
    return candidates[0].match(/tt\d+/)?.[0] || null;
  }
  const m = extra.match(/tt\d{5,}/);
  return m ? m[0] : null;
}

async function fetchFromOmdb({ title, year, imdbID }) {
  if (!OMDB_API_KEY) {
    throw new Error("OMDB_API_KEY is missing.");
  }

  const params = new URLSearchParams();
  params.set("apikey", OMDB_API_KEY);
  params.set("type", "movie");

  if (imdbID) {
    params.set("i", imdbID);
  } else {
    params.set("t", title);
    if (year) params.set("y", year);
  }

  const url = `https://www.omdbapi.com/?${params.toString()}`;

  const response = await Zotero.HTTP.request("GET", url, {
    timeout: 15000,
  });

  const json = JSON.parse(response.responseText);
  if (json.Response === "False") {
    throw new Error(json.Error || "OMDb error");
  }
  return json;
}

// ==== CORE PER-ITEM FUNCTION ====
async function updateFilmFromOmdb(item) {
  // Get title BEFORE changing item type
  const title = item.getField("title");
  const date = item.getField("date");
  const yearMatch = date && date.match(/(\d{4})/);
  const year = yearMatch ? yearMatch[1] : null;
  
  let extra = item.getField("extra") || "";
  const existingImdb = getImdbFromExtra(extra);

  if (!title) {
    return `No title found for item ${item.id}`;
  }

  // Change to film item type
  item.setType(Zotero.ItemTypes.getID("film"));

  // Fetch OMDb data
  let omdbData;
  try {
    omdbData = await fetchFromOmdb({
      title,
      year,
      imdbID: existingImdb,
    });
  } catch (err) {
    return `OMDb failed for "${title}": ${err.message}`;
  }

  // Map OMDb → Zotero fields
  if (omdbData.Title && omdbData.Title !== "N/A") {
    item.setField("title", omdbData.Title);
  }

  if (omdbData.Year && omdbData.Year !== "N/A") {
    item.setField("date", omdbData.Year);
  }

  if (omdbData.Runtime && omdbData.Runtime !== "N/A") {
    const m = omdbData.Runtime.match(/(\d+)\s*min/);
    const minutes = m ? m[1] : omdbData.Runtime;
    item.setField("runningTime", minutes);
  }

  if (omdbData.Language && omdbData.Language !== "N/A") {
    item.setField("language", omdbData.Language);
  }

  if (omdbData.Plot && omdbData.Plot !== "N/A") {
    item.setField("abstractNote", omdbData.Plot);
  }

  // Handle directors
  if (omdbData.Director && omdbData.Director !== "N/A") {
    const directors = omdbData.Director.split(",").map(d => d.trim());
    for (const director of directors) {
      item.setCreator(item.getCreators().length, {
        firstName: "",
        lastName: director,
        creatorType: "director"
      });
    }
  }

  // Handle cast
  if (omdbData.Actors && omdbData.Actors !== "N/A") {
    const actors = omdbData.Actors.split(",").map(a => a.trim());
    for (const actor of actors) {
      item.setCreator(item.getCreators().length, {
        firstName: "",
        lastName: actor,
        creatorType: "castMember"
      });
    }
  }

  // Update extra field
  const extraMap = parseExtra(extra);
  if (omdbData.imdbID && !getImdbFromExtra(extra)) {
    extraMap["IMDb ID"] = omdbData.imdbID;
  }
  if (omdbData.Country && omdbData.Country !== "N/A") {
    extraMap["Country"] = omdbData.Country;
  }
  if (omdbData.Genre && omdbData.Genre !== "N/A") {
    extraMap["Genre"] = omdbData.Genre;
  }
  if (omdbData.imdbRating && omdbData.imdbRating !== "N/A") {
    extraMap["IMDb Rating"] = omdbData.imdbRating;
  }

  item.setField("extra", serializeExtra(extraMap));

  await item.saveTx();
  
  return `✓ Updated "${omdbData.Title}" (${omdbData.Year})`;
}

// ==== MAIN EXECUTION ====
const results = [];

// Handle both single item and multiple items
const itemsToProcess = Array.isArray(items) ? items : [item];

for (const it of itemsToProcess) {
  const result = await updateFilmFromOmdb(it);
  results.push(result);
}

// Show results
return results.join("\n");

Anything else

IMPORTANT: Add Your API Key!
Before saving, you MUST replace this line in the script:
javascriptconst OMDB_API_KEY = "YOUR_API_KEY_HERE";
With your actual key:
javascriptconst OMDB_API_KEY = "a1b2c3d4"; // Your actual key here

How to Get Your Free API Key:

Go to: https://www.omdbapi.com/apikey.aspx
Click: "FREE! (1,000 daily limit)"
Enter your email
Check your email for activation link
Click activation link
Copy your API key
Paste it in the script