<?php
// $Id: l10n_packager.inc,v 1.1.2.1 2009/11/11 18:21:01 goba Exp $

/**
 * @file
 *   Localization packager module code library.
 */

// This library relies on l10n_community export.inc
module_load_include('inc', 'l10n_community', 'export');

/**
 * Check release translations and repackage if needed.
 *
 * For each release we store packaging data in {l10n_packager_release}
 * - 'checked' is the last time all languages for this release were checked.
 * - 'updated' is the last time a file was updated for this release.
 *
 * We don't updated the 'checked' field untile we've checked all the languages
 * for this release so we can keep track of releases and files and package a
 * few languages on every cron.
 *
 * @param $release
 *   Release object.
 * @param $force
 *   Force repackage even when strings not updated.
 * @param $limit
 *   Maximum number of files to create.
 * @param $language
 *   Optional language object to check only this one.
 * @param $cron
 *   In a cron run, a release may be packaged partially, for some languages.
 */
function l10n_packager_release_check($release, $force = FALSE, $limit = 0, $language = NULL, $cron = FALSE) {
  $check_languages = isset($language) ? array($language->language => $language) : l10n_community_get_languages();
  $updated = array();
  // We get update time before creating files so the release checked time
  // is <= file timestamp.
  $timestamp = time();

  $files = l10n_packager_release_get_files($release->rid);
  $last_updated = l10n_packager_translation_last_updated($release->rid);

  // Get only the languages we have translations for, that need updating
  $languages = array();
  foreach($check_languages as $langcode => $language) {
    if (!empty($last_updated[$langcode]) && ($force || empty($files[$langcode]) || ($last_updated[$langcode] > $files[$langcode]->checked))) {
      $languages[$langcode] = $language;
    }
  }

  // For this special case we check we didn't stop before in the middle of a
  // release. Otherwise it could stick on a release forever when forcing.
  if ($force && $cron && $release->checked < $release->updated) {
    foreach($files as $lang => $file) {
      if (!empty($file->checked) && ($file->checked > $release->checked)) {
        unset($languages[$lang]);
      }
    }
  }

  // Repackage this relase for the remaining language list.
  while ((!$limit || $limit > count($updated)) && ($language = array_shift($languages))) {
    $langcode = $language->language;
    // Warning: this may upload release data with or without file.
    $existing = !empty($files[$langcode]) ? $files[$langcode] : NULL;
    $updated[$langcode] = l10n_packager_release_package($release, $language, $existing, $timestamp);
  }

  // Update the release data.
  if (!count($languages)) {
    // We only mark the release checked if there are no languages left.
    $release->checked = $timestamp;
  }
  if ($updated) {
    $release->updated = $timestamp;
  }

  if (isset($release->status)) {
    // Just update status of existing record.
    drupal_write_record('l10n_packager_release', $release, 'rid');
  }
  else {
    // The first time we checked this release, we need to add a new record.
    $release->status = L10N_PACKAGER_ACTIVE;
    drupal_write_record('l10n_packager_release', $release);
  }
  return $updated;
}

/**
 * Generate a new file for a given release or update an existing one.
 *
 * @param $release
 *   Release object with uri and rid properties.
 * @param $language
 *   Language object.
 * @param $file
 *   Release file object to be updated.
 * @param $timestamp
 *   Timestamp to mark the files, for it to be consistent across tables.
 *
 * @return
 *   Drupal file object or FALSE on error.
 */
function l10n_packager_release_package($release, $language, $file = NULL, $timestamp = NULL) {

  $timestamp = $timestamp ? $timestamp : time();
  $variables = array(
    '%release'  => l10n_packager_release_name($release),
    '%language' => $language->name
  );

  if (!$file) {
    $file = new stdClass();
    $file->rid = $release->rid;
    $file->language = $language->language;
  }

  // Generate PO file. Always export all-in-one format in compact form.
  $export_result = l10n_community_export($release->uri, $release->rid, $language, FALSE, 'all-in-one', TRUE);

  if (!empty($export_result) && is_array($export_result)) {

    // If we got an array back from the export build, tear that into pieces.
    list($mime_type, $export_name, $serve_name) = $export_result;

    // Get the destination file path.
    $file_path = l10n_packager_get_filepath($release, $language);
    // Build the full path and make sure the directory exits.
    $file_path = l10n_packager_create_path($file_path);

    // Now build the Drupal file object or update the old one.
    if (!empty($file->fid) && !empty($file->filepath)) {
      file_delete($file->filepath);
    }

    // Check / upate / create all file data.
    $file->status = FILE_STATUS_PERMANENT;
    $file->timestamp = $file->checked = $timestamp;
    $file->filename = basename($file_path);
    $file->filemime = $mime_type;
    $file->filepath = $file_path;
    file_move($export_name, $file->filepath, FILE_EXISTS_REPLACE);
    $file->filesize = filesize($file->filepath);

    // Create / update file record and link to release.
    drupal_write_record('files', $file, !empty($file->fid) ? 'fid' : array());
    drupal_write_record('l10n_packager_file', $file, !empty($file->drid) ? 'drid' : array());
    $variables['%filename'] = $file->filename;
    watchdog('l10n_packager', 'Packaged release %release for language %language, created file %filename.', $variables);
    return $file;

  }
  else {
    watchdog('l10n_packager', 'Failed packaging release %release for language %language.', $variables);
    return FALSE;
  }
}

// == Batch functions ==========================================================

/**
 * Create batch for repackaging releases.
 *
 * @param $rid
 *   Release id or array of release ids.
 * @param $languages
 *   Array of language codes to repackage or none.
 *
 * @return
 *   Batch array.
 */
function l10n_packager_release_batch($rid, $languages = NULL) {
  $rids = is_array($rid) ? $rid : array($rid);

  // All languages if no languages passed
  $languages = !empty($languages) ? $languages : array_keys(l10n_community_get_languages());
  foreach ($rids as $rid) {
    foreach ($languages as $langcode) {
      $operations[] = array('_l10n_packager_batch_repackage', array($rid, $langcode));
    }
  }

  if (!empty($operations)) {
    return _l10n_packager_build_batch($operations, t('Repackaging translation files.'));
  }
}

/**
 * Get batch stub.
 */
function _l10n_packager_build_batch($operations = array(), $title = '') {
  $batch = array(
    'title' => $title ? $title : t('Translations packager.'),
    'operations' => $operations,
    // Tell the batch engine which file to load before calling operations.
    'file' => drupal_get_path('module', 'l10n_packager') .'/l10n_packager.inc',
  );
  return $batch;
}

/**
 * Batch callback to repackage a release.
 *
 * @param $rid
 *   Release id.
 * @param $langcode
 *   Language object to package.
 */
function _l10n_packager_batch_repackage($rid, $langcode) {
  if ($release = l10n_packager_get_release($rid)) {
    $languages = l10n_community_get_languages();
    $language = $languages[$langcode];
    $updates = l10n_packager_release_check($release, TRUE, 0, $language);
    if ($file = current($updates)) {
      drupal_set_message(t("Repackaged release %release for %language. Created file %filename.", array('%release' => l10n_packager_release_name($release), '%filename' => $file->filename, '%language' => $language->name)));
    }
  }
}

// == Utility functions ========================================================

/**
 * Get release object with packager data and some project data.
 */
function l10n_packager_get_release($rid) {
  if (is_object($rid)) {
    return $rid;
  }
  else {
    return db_fetch_object(db_query("SELECT r.rid, r.pid, r.title, pr.checked, pr.updated, pr.status, p.uri FROM {l10n_community_project} p INNER JOIN {l10n_community_release} r ON p.pid = r.pid LEFT JOIN {l10n_packager_release} pr ON r.rid = pr.rid WHERE r.rid = %d", $rid));
  }
}

/**
 * Get release name.
 */
function l10n_packager_release_name($rid) {
  if ($release = l10n_packager_get_release($rid)) {
    return $release->uri .'-'. $release->title;
  }
  else {
    return '';
  }
}

/**
 * Get timestamp of the last updated string for a release, for each language.
 */
function l10n_packager_translation_last_updated($rid) {
  $updated = array();
  $result = db_query("SELECT t.language, MAX(t.time_approved) AS latest_time FROM {l10n_community_translation} t INNER JOIN {l10n_community_line} l ON t.sid = l.sid INNER JOIN {l10n_community_file} f ON f.fid = l.fid WHERE t.is_active = 1 AND t.is_suggestion = 0 AND f.rid = %d GROUP BY t.language", $rid);
  while ($latest = db_fetch_object($result)) {
    $updated[$latest->language] = $latest->latest_time;
  }
  return $updated;
}

/**
 * Get files for a release, indexed by language.
 */
function l10n_packager_release_get_files($rid) {
  $files = array();
  $result = db_query('SELECT * FROM {l10n_packager_file} r LEFT JOIN {files} f ON r.fid = f.fid WHERE r.rid = %d', $rid);
  while ($file = db_fetch_object($result)) {
    $files[$file->language] = $file;
  }
  return $files;
}