/* vi:set et ai sw=2 sts=2 ts=2: */
/*-
 * Copyright (c) 2009-2011 Jannis Pohlmann <jannis@xfce.org>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General
 * Public License along with this library; if not, write to the
 * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 */

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include "xdg-cache-cache.h"
#include "xdg-cache-thumbnail.h"

#include <gdk-pixbuf/gdk-pixbuf.h>
#include <glib/gi18n.h>
#include <glib/gprintf.h>
#include <glib/gstdio.h>
#include <math.h>
#include <png.h>
#include <stdlib.h>
#include <string.h>



static void
xdg_cache_cache_iface_init (TumblerCacheIface *iface);
static void
xdg_cache_cache_finalize (GObject *object);
static TumblerThumbnail *
xdg_cache_cache_get_thumbnail (TumblerCache *cache,
                               const gchar *uri,
                               TumblerThumbnailFlavor *flavor);
static void
xdg_cache_cache_cleanup (TumblerCache *cache,
                         const gchar *const *base_uris,
                         gdouble since);
static void
xdg_cache_cache_delete (TumblerCache *cache,
                        const gchar *const *uris);
static void
xdg_cache_cache_copy (TumblerCache *cache,
                      const gchar *const *from_uris,
                      const gchar *const *to_uris);
static void
xdg_cache_cache_move (TumblerCache *cache,
                      const gchar *const *from_uris,
                      const gchar *const *to_uris);
static gboolean
xdg_cache_cache_is_thumbnail (TumblerCache *cache,
                              const gchar *uri);
static GList *
xdg_cache_cache_get_flavors (TumblerCache *cache);



struct _XDGCacheCache
{
  GObject __parent__;

  GList *flavors;
  GList *dirs;
  GList *shared_suffixes;
};



G_DEFINE_DYNAMIC_TYPE_EXTENDED (XDGCacheCache,
                                xdg_cache_cache,
                                G_TYPE_OBJECT,
                                0,
                                G_IMPLEMENT_INTERFACE_DYNAMIC (TUMBLER_TYPE_CACHE,
                                                               xdg_cache_cache_iface_init));



void
xdg_cache_cache_register (TumblerCachePlugin *plugin)
{
  xdg_cache_cache_register_type (G_TYPE_MODULE (plugin));
}



static void
xdg_cache_cache_class_init (XDGCacheCacheClass *klass)
{
  GObjectClass *gobject_class;

  gobject_class = G_OBJECT_CLASS (klass);
  gobject_class->finalize = xdg_cache_cache_finalize;
}



static void
xdg_cache_cache_class_finalize (XDGCacheCacheClass *klass)
{
}



static void
xdg_cache_cache_iface_init (TumblerCacheIface *iface)
{
  iface->get_thumbnail = xdg_cache_cache_get_thumbnail;
  iface->cleanup = xdg_cache_cache_cleanup;
  iface->do_delete = xdg_cache_cache_delete;
  iface->copy = xdg_cache_cache_copy;
  iface->move = xdg_cache_cache_move;
  iface->is_thumbnail = xdg_cache_cache_is_thumbnail;
  iface->get_flavors = xdg_cache_cache_get_flavors;
}



static void
xdg_cache_cache_init (XDGCacheCache *cache)
{
  TumblerThumbnailFlavor *flavor;
  const gchar *cachedir = g_get_user_cache_dir ();

  flavor = tumbler_thumbnail_flavor_new_normal ();
  cache->flavors = g_list_prepend (cache->flavors, flavor);

  flavor = tumbler_thumbnail_flavor_new_large ();
  cache->flavors = g_list_prepend (cache->flavors, flavor);

  flavor = tumbler_thumbnail_flavor_new_x_large ();
  cache->flavors = g_list_prepend (cache->flavors, flavor);

  flavor = tumbler_thumbnail_flavor_new_xx_large ();
  cache->flavors = g_list_prepend (cache->flavors, flavor);

  for (GList *lp = cache->flavors; lp != NULL; lp = lp->next)
    {
      const gchar *dirname = tumbler_thumbnail_flavor_get_name (lp->data);
      gchar *path = g_build_filename (cachedir, "thumbnails", dirname, NULL);
      gchar *suffix = g_strconcat (G_DIR_SEPARATOR_S, ".sh_thumbnails", G_DIR_SEPARATOR_S, dirname, NULL);
      cache->dirs = g_list_prepend (cache->dirs, g_file_new_for_path (path));
      cache->shared_suffixes = g_list_prepend (cache->shared_suffixes, suffix);
      g_free (path);
    }
}



static void
xdg_cache_cache_finalize (GObject *object)
{
  XDGCacheCache *cache = XDG_CACHE_CACHE (object);

  g_list_free_full (cache->flavors, g_object_unref);
  g_list_free_full (cache->dirs, g_object_unref);
  g_list_free_full (cache->shared_suffixes, g_free);

  G_OBJECT_CLASS (xdg_cache_cache_parent_class)->finalize (object);
}



static TumblerThumbnail *
xdg_cache_cache_get_thumbnail (TumblerCache *cache,
                               const gchar *uri,
                               TumblerThumbnailFlavor *flavor)
{
  g_return_val_if_fail (XDG_CACHE_IS_CACHE (cache), NULL);
  g_return_val_if_fail (uri != NULL && *uri != '\0', NULL);
  g_return_val_if_fail (TUMBLER_IS_THUMBNAIL_FLAVOR (flavor), NULL);

  /* TODO check if the flavor is supported */

  return g_object_new (XDG_CACHE_TYPE_THUMBNAIL, "cache", cache,
                       "uri", uri, "flavor", flavor, NULL);
}



static void
xdg_cache_cache_cleanup (TumblerCache *cache,
                         const gchar *const *base_uris,
                         gdouble since)
{
  XDGCacheCache *xdg_cache = XDG_CACHE_CACHE (cache);
  const gchar *file_basename;
  gdouble mtime;
  GFile *base_file;
  GFile *dummy_file;
  GFile *original_file;
  GFile *parent;
  GList *iter;
  gchar *dirname;
  gchar *filename;
  gchar *uri;
  guint n;
  GDir *dir;

  g_return_if_fail (XDG_CACHE_IS_CACHE (cache));

  /* iterate over all flavors */
  for (iter = xdg_cache->flavors; iter != NULL; iter = iter->next)
    {
      if (since != 0)
        {
          /* compute the flavor directory filename */
          dummy_file = xdg_cache_cache_get_file ("foo", iter->data);
          parent = g_file_get_parent (dummy_file);
          dirname = g_file_get_path (parent);
          g_object_unref (parent);
          g_object_unref (dummy_file);

          /* attempt to open the directory for reading */
          dir = g_dir_open (dirname, 0, NULL);
          if (dir != NULL)
            {
              /* iterate over all files in the directory */
              file_basename = g_dir_read_name (dir);
              while (file_basename != NULL)
                {
                  /* build the thumbnail filename */
                  filename = g_build_filename (dirname, file_basename, NULL);

                  /* read thumbnail information from the file */
                  if (xdg_cache_cache_read_thumbnail_info (filename, &uri, &mtime,
                                                           NULL, NULL))
                    {
                      /* check if the thumbnail information is valid or the mtime
                       * is too old */
                      if (uri == NULL || mtime <= since)
                        {
                          /* it's invalid, so let's remove the thumbnail */
                          g_unlink (filename);
                        }
                      else
                        {
                          /* create a GFile for the original URI. we need this for
                           * reliably checking the ancestor/descendant relationship */
                          original_file = g_file_new_for_uri (uri);

                          for (n = 0; base_uris != NULL && base_uris[n] != NULL; ++n)
                            {
                              /* create a GFile for the base URI */
                              base_file = g_file_new_for_uri (base_uris[n]);

                              /* delete the file if it is a descendant of the base URI */
                              if (g_file_equal (original_file, base_file)
                                  || g_file_has_prefix (original_file, base_file))
                                {
                                  g_unlink (filename);
                                }

                              /* releas the base file */
                              g_object_unref (base_file);
                            }

                          /* release the original file */
                          g_object_unref (original_file);
                        }
                    }

                  /* free the thumbnail filename */
                  g_free (filename);

                  /* try to determine the next filename in the directory */
                  file_basename = g_dir_read_name (dir);
                }

              /* close the handle used to reading from the directory */
              g_dir_close (dir);
            }

          /* free the thumbnail flavor directory filename */
          g_free (dirname);
        }
      /* According to the spec, mtime since can be 0 to ignore the threshold and
       * only cleanup based on the URI prefix array. */
      else
        {
          for (n = 0; base_uris != NULL && base_uris[n] != NULL; ++n)
            {
              base_file = xdg_cache_cache_get_file (base_uris[n], iter->data);

              filename = (gchar *) g_file_peek_path (base_file);
              if (g_file_test (filename, G_FILE_TEST_IS_REGULAR))
                {
                  g_unlink (filename);
                }

              /* releas the base file */
              g_object_unref (base_file);
            }
        }
    }
}



static void
xdg_cache_cache_delete (TumblerCache *cache,
                        const gchar *const *uris)
{
  XDGCacheCache *xdg_cache = XDG_CACHE_CACHE (cache);
  GList *iter;
  GFile *file;
  gint n;

  g_return_if_fail (XDG_CACHE_IS_CACHE (cache));
  g_return_if_fail (uris != NULL);

  for (iter = xdg_cache->flavors; iter != NULL; iter = iter->next)
    {
      for (n = 0; uris[n] != NULL; ++n)
        {
          file = xdg_cache_cache_get_file (uris[n], iter->data);
          g_file_delete (file, NULL, NULL);
          g_object_unref (file);
        }
    }
}



static void
xdg_cache_cache_copy_or_move_file (TumblerCache *cache,
                                   TumblerThumbnailFlavor *flavor,
                                   gboolean do_copy,
                                   const gchar *from_uri,
                                   const gchar *to_uri,
                                   gdouble mtime)
{
  GFile *from_file;
  GFile *temp_file;
  const gchar *temp_path;
  const gchar *dest_path;
  gboolean result;
  GFile *dest_file;

  from_file = xdg_cache_cache_get_file (from_uri, flavor);
  temp_file = xdg_cache_cache_get_temp_file (to_uri, flavor);

  if (do_copy)
    {
      result = g_file_copy (from_file, temp_file, G_FILE_COPY_OVERWRITE,
                            NULL, NULL, NULL, NULL);
    }
  else
    {
      result = g_file_move (from_file, temp_file, G_FILE_COPY_OVERWRITE,
                            NULL, NULL, NULL, NULL);
    }

  if (result)
    {
      temp_path = g_file_peek_path (temp_file);

      if (xdg_cache_cache_write_thumbnail_info (temp_path, to_uri, mtime,
                                                NULL, NULL))
        {
          dest_file = xdg_cache_cache_get_file (to_uri, flavor);
          dest_path = g_file_peek_path (dest_file);

          if (g_rename (temp_path, dest_path) != 0)
            g_unlink (temp_path);

          g_object_unref (dest_file);
        }
      else
        {
          g_unlink (temp_path);
        }
    }
  else if (!do_copy)
    {
      /* if the move failed, drop the old cache file */
      g_unlink (g_file_peek_path (from_file));
    }

  g_object_unref (temp_file);
  g_object_unref (from_file);
}



static void
xdg_cache_cache_copy_or_move (TumblerCache *cache,
                              gboolean do_copy,
                              const gchar *const *from_uris,
                              const gchar *const *to_uris)
{
  XDGCacheCache *xdg_cache = XDG_CACHE_CACHE (cache);
  GFileInfo *info;
  gdouble mtime;
  GFile *dest_source_file;
  GList *iter;
  guint n;
  GFile *dummy_file;
  GFile *parent;
  gchar *dirname;
  GDir *dir;
  const gchar *file_basename;
  gchar *filename;
  gchar *uri;
  GFile *original_file;
  GFile *base_file;
  gchar *to_uri;

  g_return_if_fail (XDG_CACHE_IS_CACHE (cache));
  g_return_if_fail (from_uris != NULL);
  g_return_if_fail (to_uris != NULL);

  for (iter = xdg_cache->flavors; iter != NULL; iter = iter->next)
    {
      for (n = 0; n < g_strv_length ((gchar **) from_uris); ++n)
        {
          dest_source_file = g_file_new_for_uri (to_uris[n]);
          info = g_file_query_info (dest_source_file,
                                    G_FILE_ATTRIBUTE_STANDARD_TYPE
                                    "," G_FILE_ATTRIBUTE_TIME_MODIFIED
                                    "," G_FILE_ATTRIBUTE_TIME_MODIFIED_USEC,
                                    G_FILE_QUERY_INFO_NONE, NULL, NULL);

          if (info == NULL)
            {
              g_object_unref (dest_source_file);
              continue;
            }

          if (g_file_info_get_file_type (info) == G_FILE_TYPE_DIRECTORY)
            {
              /* compute the flavor directory filename */
              dummy_file = xdg_cache_cache_get_file ("foo", iter->data);
              parent = g_file_get_parent (dummy_file);
              dirname = g_file_get_path (parent);
              g_object_unref (parent);
              g_object_unref (dummy_file);

              /* the base path */
              base_file = g_file_new_for_uri (from_uris[n]);

              /* attempt to open the directory for reading */
              dir = g_dir_open (dirname, 0, NULL);
              if (dir != NULL)
                {
                  /* iterate over all files in the directory */
                  file_basename = g_dir_read_name (dir);
                  while (file_basename != NULL)
                    {
                      /* build the thumbnail filename */
                      filename = g_build_filename (dirname, file_basename, NULL);

                      /* read thumbnail information from the file */
                      if (xdg_cache_cache_read_thumbnail_info (filename, &uri, &mtime, NULL, NULL)
                          && uri != NULL)
                        {
                          /* create a GFile for the original URI. we need this for
                           * reliably checking the ancestor/descendant relationship */
                          original_file = g_file_new_for_uri (uri);

                          /* check if we have a thumbnail that is located in the moved/copied folder */
                          if (g_file_equal (original_file, base_file)
                              || g_file_has_prefix (original_file, base_file))
                            {
                              /* build the new target (replace old base with new base) */
                              to_uri = g_build_filename (to_uris[n], uri + strlen (from_uris[n]), NULL);

                              /* move or copy the thumbnail */
                              xdg_cache_cache_copy_or_move_file (cache, iter->data,
                                                                 do_copy,
                                                                 uri, to_uri,
                                                                 mtime);

                              g_free (to_uri);
                            }

                          g_object_unref (original_file);
                          g_free (uri);
                        }

                      g_free (filename);

                      /* try to determine the next filename in the directory */
                      file_basename = g_dir_read_name (dir);
                    }

                  g_dir_close (dir);
                }

              g_free (dirname);
              g_object_unref (base_file);
            }
          else
            {
              mtime = g_file_info_get_attribute_uint64 (info, G_FILE_ATTRIBUTE_TIME_MODIFIED)
                      + 1e-6 * g_file_info_get_attribute_uint32 (info, G_FILE_ATTRIBUTE_TIME_MODIFIED_USEC);
              xdg_cache_cache_copy_or_move_file (cache, iter->data, do_copy,
                                                 from_uris[n], to_uris[n],
                                                 mtime);
            }

          g_object_unref (info);
          g_object_unref (dest_source_file);
        }
    }
}



static void
xdg_cache_cache_copy (TumblerCache *cache,
                      const gchar *const *from_uris,
                      const gchar *const *to_uris)
{
  xdg_cache_cache_copy_or_move (cache, TRUE, from_uris, to_uris);
}



static void
xdg_cache_cache_move (TumblerCache *cache,
                      const gchar *const *from_uris,
                      const gchar *const *to_uris)
{
  xdg_cache_cache_copy_or_move (cache, FALSE, from_uris, to_uris);
}



static gboolean
xdg_cache_cache_is_thumbnail (TumblerCache *cache,
                              const gchar *uri)
{
  XDGCacheCache *xdg_cache = XDG_CACHE_CACHE (cache);
  gboolean is_thumbnail = FALSE;
  GFile *file;
  gchar *uri_dir;

  g_return_val_if_fail (XDG_CACHE_IS_CACHE (cache), FALSE);
  g_return_val_if_fail (uri != NULL, FALSE);

  /* check if it is a thumbnail in local cache */
  file = g_file_new_for_uri (uri);
  for (GList *lp = xdg_cache->dirs; lp != NULL; lp = lp->next)
    {
      if (g_file_has_parent (file, lp->data))
        {
          is_thumbnail = TRUE;
          break;
        }
    }
  g_object_unref (file);

  if (is_thumbnail)
    return TRUE;

  /* check if it is a thumbnail in a shared repository */
  uri_dir = g_path_get_dirname (uri);
  for (GList *lp = xdg_cache->shared_suffixes; lp != NULL; lp = lp->next)
    {
      if (g_str_has_suffix (uri_dir, lp->data))
        {
          is_thumbnail = TRUE;
          break;
        }
    }
  g_free (uri_dir);

  return is_thumbnail;
}



static GList *
xdg_cache_cache_get_flavors (TumblerCache *cache)
{
  XDGCacheCache *xdg_cache = XDG_CACHE_CACHE (cache);
  GList *flavors = NULL;
  GList *iter;

  g_return_val_if_fail (XDG_CACHE_IS_CACHE (cache), NULL);

  for (iter = g_list_last (xdg_cache->flavors); iter != NULL; iter = iter->prev)
    flavors = g_list_prepend (flavors, g_object_ref (iter->data));

  return flavors;
}



GFile *
xdg_cache_cache_get_file (const gchar *uri,
                          TumblerThumbnailFlavor *flavor)
{
  const gchar *cachedir;
  const gchar *dirname;
  GFile *file;
  gchar *filename;
  gchar *md5_hash;
  gchar *path;

  g_return_val_if_fail (uri != NULL && *uri != '\0', NULL);
  g_return_val_if_fail (TUMBLER_IS_THUMBNAIL_FLAVOR (flavor), NULL);

  cachedir = g_get_user_cache_dir ();
  dirname = tumbler_thumbnail_flavor_get_name (flavor);

  md5_hash = g_compute_checksum_for_string (G_CHECKSUM_MD5, uri, -1);
  filename = g_strdup_printf ("%s.png", md5_hash);
  path = g_build_filename (cachedir, "thumbnails", dirname, filename, NULL);

  file = g_file_new_for_path (path);

  g_free (path);
  g_free (filename);
  g_free (md5_hash);

  return file;
}



GFile *
xdg_cache_cache_get_temp_file (const gchar *uri,
                               TumblerThumbnailFlavor *flavor)
{
  const gchar *cachedir;
  const gchar *dirname;
  gint64 current_time;
  GFile *file;
  gchar *filename;
  gchar *md5_hash;
  gchar *path;

  g_return_val_if_fail (uri != NULL && *uri != '\0', NULL);
  g_return_val_if_fail (TUMBLER_IS_THUMBNAIL_FLAVOR (flavor), NULL);

  cachedir = g_get_user_cache_dir ();
  dirname = tumbler_thumbnail_flavor_get_name (flavor);

  current_time = g_get_real_time ();

  md5_hash = g_compute_checksum_for_string (G_CHECKSUM_MD5, uri, -1);
  filename = g_strdup_printf ("%s-%ld.png", md5_hash,
                              current_time / G_USEC_PER_SEC);
  path = g_build_filename (cachedir, "thumbnails", dirname, filename, NULL);

  file = g_file_new_for_path (path);

  g_free (path);
  g_free (filename);
  g_free (md5_hash);

  return file;
}



/* Will return %TRUE if the thumbnail was loaded successfully, or did not exist.
 * Check whether @uri is non-%NULL and @mtime is a valid time to determine
 * between the two. Will return %FALSE and set @error if the PNG was corrupt. */
gboolean
xdg_cache_cache_read_thumbnail_info (const gchar *filename,
                                     gchar **uri,
                                     gdouble *mtime,
                                     GCancellable *cancellable,
                                     GError **error)
{
  png_structp png_ptr;
  png_infop info_ptr;
  png_textp text_ptr;
  gboolean has_uri;
  gboolean has_mtime;
  FILE *png;
  gint num_text;
  gint i;

  g_return_val_if_fail (filename != NULL, FALSE);
  g_return_val_if_fail (uri != NULL, FALSE);
  g_return_val_if_fail (mtime != NULL, FALSE);
  g_return_val_if_fail (cancellable == NULL || G_IS_CANCELLABLE (cancellable), FALSE);
  g_return_val_if_fail (error == NULL || *error == NULL, FALSE);

  *uri = NULL;
  *mtime = 0;

  if (g_cancellable_set_error_if_cancelled (cancellable, error))
    return FALSE;

  if ((png = g_fopen (filename, "r")) != NULL)
    {
      /* initialize the PNG reader */
      png_ptr = png_create_read_struct (PNG_LIBPNG_VER_STRING, NULL, NULL, NULL);

      if (png_ptr)
        {
          /* initialize the info structure */
          info_ptr = png_create_info_struct (png_ptr);

          if (info_ptr)
            {
#ifdef PNG_SETJMP_SUPPORTED
              if (setjmp (png_jmpbuf (png_ptr)))
                {
                  /* finalize the PNG reader */
                  png_destroy_read_struct (&png_ptr, &info_ptr, NULL);

                  /* close the PNG file handle */
                  fclose (png);

                  /* set an error */
                  g_set_error (error, TUMBLER_ERROR, TUMBLER_ERROR_INVALID_FORMAT,
                               TUMBLER_ERROR_MESSAGE_CORRUPT_THUMBNAIL, filename);

                  return FALSE;
                }
#endif

              /* initialize reading from the file and read the file info */
              png_init_io (png_ptr, png);
              png_read_info (png_ptr, info_ptr);

              /* check if there is embedded text information */
              if (png_get_text (png_ptr, info_ptr, &text_ptr, &num_text) > 0)
                {
                  /* iterate over all text keys */
                  for (i = 0, has_uri = FALSE, has_mtime = FALSE;
                       !(has_uri && has_mtime) && i < num_text; ++i)
                    {
                      if (!text_ptr[i].key)
                        continue;

                      if (strcmp ("Thumb::URI", text_ptr[i].key) == 0)
                        {
                          /* remember the Thumb::URI value */
                          *uri = g_strdup (text_ptr[i].text);
                          has_uri = TRUE;
                        }
                      else if (strcmp ("Thumb::MTime", text_ptr[i].key) == 0)
                        {
                          /* remember the Thumb::MTime value */
                          if (text_ptr[i].text != NULL)
                            {
                              *mtime = g_ascii_strtod (text_ptr[i].text, NULL);
                              has_mtime = TRUE;
                            }
                        }
                    }
                }
            }

          /* finalize the PNG reader */
          png_destroy_read_struct (&png_ptr, &info_ptr, NULL);
        }

      /* close the PNG file handle */
      fclose (png);
    }

  return TRUE;
}



gboolean
xdg_cache_cache_write_thumbnail_info (const gchar *filename,
                                      const gchar *uri,
                                      gdouble mtime,
                                      GCancellable *cancellable,
                                      GError **error)
{
  GdkPixbuf *pixbuf;
  GError *err = NULL;
  gchar *mtime_str;
  guint64 mtime_int = (guint64) mtime;

  g_return_val_if_fail (filename != NULL, FALSE);
  g_return_val_if_fail (cancellable == NULL || G_IS_CANCELLABLE (cancellable), FALSE);
  g_return_val_if_fail (error == NULL || *error == NULL, FALSE);

  if (g_cancellable_set_error_if_cancelled (cancellable, error))
    return FALSE;

  pixbuf = gdk_pixbuf_new_from_file (filename, &err);

  if (pixbuf != NULL)
    {
      if (!g_cancellable_set_error_if_cancelled (cancellable, &err))
        {
          mtime_str = g_strdup_printf ("%" G_GUINT64_FORMAT ".%.6" G_GUINT32_FORMAT,
                                       mtime_int, (guint32) round (1.e6 * (mtime - mtime_int)));

          gdk_pixbuf_save (pixbuf, filename, "png", &err,
                           "tEXt::Thumb::URI", uri,
                           "tEXt::Thumb::MTime", mtime_str,
                           NULL);

          g_free (mtime_str);
        }

      g_object_unref (pixbuf);
    }

  if (err != NULL)
    {
      g_propagate_error (error, err);
      return FALSE;
    }
  else
    {
      return TRUE;
    }
}
