libcheese/cheese-fileutil.c

   1 /*
   2  * Copyright © 2007,2008 daniel g. siegel <dgsiegel@gnome.org>
   3  * Copyright © 2007,2008 Jaap Haitsma <jaap@haitsma.org>
   4  * Copyright © 2008 Felix Kaser <f.kaser@gmx.net>
   5  *
   6  * Licensed under the GNU General Public License Version 2
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20  */
  21
  22 #ifdef HAVE_CONFIG_H
  23   #include <config.h>
  24 #endif
  25
  26 #include <glib.h>
  27 #include <gio/gio.h>
  28 #include <string.h>
  29 #include <glib/gi18n-lib.h>
  30
  31 #include "cheese-fileutil.h"
  32
  33 /**
  34  * SECTION:cheese-file-util
  35  * @short_description: File utility functions for Cheese
  36  * @stability: Unstable
  37  * @include: cheese/cheese-fileutil.h
  38  *
  39  * #CheeseFileUtil provides some helpful utility functions for looking up paths
  40  * for photos and videos.
  41  */
  42
  43 typedef struct
  44 {
  45   gchar *video_path;
  46   gchar *photo_path;
  47   guint  burst_count;
  48   gchar *burst_raw_name;
  49 } CheeseFileUtilPrivate;
  50
  51 G_DEFINE_TYPE_WITH_PRIVATE (CheeseFileUtil, cheese_fileutil, G_TYPE_OBJECT)
  52
  53 static gchar *
  54 cheese_fileutil_get_path_before_224 (CheeseFileUtil *fileutil);
  55
  56 /**
  57  * cheese_fileutil_get_video_path:
  58  * @fileutil: a #CheeseFileUtil
  59  *
  60  * Get the path where Cheese video files are stored.
  61  *
  62  * Returns: (transfer none) (type filename): the Cheese video path
  63  */
  64 const gchar *
  65 cheese_fileutil_get_video_path (CheeseFileUtil *fileutil)
  66 {
  67     CheeseFileUtilPrivate *priv;
  68
  69   g_return_val_if_fail (CHEESE_IS_FILEUTIL (fileutil), NULL);
  70
  71     priv = cheese_fileutil_get_instance_private (fileutil);
  72
  73     return priv->video_path;
  74 }
  75
  76 /**
  77  * cheese_fileutil_get_photo_path:
  78  * @fileutil: a #CheeseFileUtil
  79  *
  80  * Get the path where Cheese photo files are stored.
  81  *
  82  * Returns: (transfer none) (type filename): the Cheese photo path
  83  */
  84 const gchar *
  85 cheese_fileutil_get_photo_path (CheeseFileUtil *fileutil)
  86 {
  87     CheeseFileUtilPrivate *priv;
  88
  89   g_return_val_if_fail (CHEESE_IS_FILEUTIL (fileutil), NULL);
  90
  91     priv = cheese_fileutil_get_instance_private (fileutil);
  92
  93     return priv->photo_path;
  94 }
  95
  96 /*
  97  * cheese_fileutil_get_path_before_224:
  98  * @fileutil: a #CheeseFileUtil
  99  *
 100  * Returns: (transfer full) (type filename): the photo path for Cheese versions before 2.24
 101  */
 102 static gchar *
 103 cheese_fileutil_get_path_before_224 (CheeseFileUtil *fileutil)
 104 {
 105   return g_build_filename (g_get_home_dir (), ".gnome2", "cheese", "media", NULL);
 106 }
 107
 108 /**
 109  * cheese_fileutil_get_new_media_filename:
 110  * @fileutil: a #CheeseFileUtil
 111  * @mode: the type of media to create a filename for
 112  *
 113  * Creates a filename for one of the three media types: photo, photo burst or
 114  * video. If a filename for a photo burst image was previously created, this
 115  * function increments the burst count automatically. To start a new burst,
 116  * first call cheese_fileutil_reset_burst().
 117  *
 118  * Returns: (transfer full) (type filename): a new filename
 119  */
 120 gchar *
 121 cheese_fileutil_get_new_media_filename (CheeseFileUtil *fileutil, CheeseMediaMode mode)
 122 {
 123   GDateTime *datetime;
 124   gchar       *time_string;
 125   const gchar *path;
 126   gchar       *filename;
 127   GFile       *file;
 128   guint        num;
 129   CheeseFileUtilPrivate *priv;
 130
 131   g_return_val_if_fail (CHEESE_IS_FILEUTIL (fileutil), NULL);
 132
 133     priv = cheese_fileutil_get_instance_private (fileutil);
 134
 135   datetime = g_date_time_new_now_local ();
 136
 137   g_assert (datetime != NULL);
 138
 139   time_string = g_date_time_format (datetime, "%F-%H%M%S");
 140   g_date_time_unref (datetime);
 141
 142   g_assert (time_string != NULL);
 143
 144   switch (mode)
 145   {
 146     case CHEESE_MEDIA_MODE_PHOTO:
 147     case CHEESE_MEDIA_MODE_BURST:
 148       path = cheese_fileutil_get_photo_path (fileutil);
 149       break;
 150     case CHEESE_MEDIA_MODE_VIDEO:
 151       path = cheese_fileutil_get_video_path (fileutil);
 152       break;
 153     default:
 154       g_assert_not_reached ();
 155   }
 156
 157   g_mkdir_with_parents (path, 0775);
 158
 159   switch (mode)
 160   {
 161     case CHEESE_MEDIA_MODE_PHOTO:
 162       filename = g_strdup_printf ("%s%s%s%s", path, G_DIR_SEPARATOR_S, time_string, CHEESE_PHOTO_NAME_SUFFIX);
 163       break;
 164     case CHEESE_MEDIA_MODE_BURST:
 165       priv->burst_count++;
 166       if (strlen (priv->burst_raw_name) == 0)
 167       {
 168         g_free (priv->burst_raw_name);
 169         priv->burst_raw_name = g_strdup_printf ("%s%s%s", path, G_DIR_SEPARATOR_S, time_string);
 170       }
 171
 172       filename = g_strdup_printf ("%s_%d%s", priv->burst_raw_name, priv->burst_count, CHEESE_PHOTO_NAME_SUFFIX);
 173       break;
 174     case CHEESE_MEDIA_MODE_VIDEO:
 175       filename = g_strdup_printf ("%s%s%s%s", path, G_DIR_SEPARATOR_S, time_string, CHEESE_VIDEO_NAME_SUFFIX);
 176       break;
 177     default:
 178       g_assert_not_reached ();
 179   }
 180
 181   file = g_file_new_for_path (filename);
 182   num = 0;
 183
 184   while (g_file_query_exists (file, NULL))
 185   {
 186     num++;
 187
 188     g_object_unref (file);
 189     g_free (filename);
 190
 191     switch (mode)
 192     {
 193       case CHEESE_MEDIA_MODE_PHOTO:
 194         filename = g_strdup_printf ("%s%s%s (%d)%s", path, G_DIR_SEPARATOR_S, time_string, num, CHEESE_PHOTO_NAME_SUFFIX);
 195         break;
 196       case CHEESE_MEDIA_MODE_BURST:
 197         filename = g_strdup_printf ("%s_%d (%d)%s", priv->burst_raw_name, priv->burst_count, num, CHEESE_PHOTO_NAME_SUFFIX);
 198         break;
 199       case CHEESE_MEDIA_MODE_VIDEO:
 200         filename = g_strdup_printf ("%s%s%s (%d)%s", path, G_DIR_SEPARATOR_S, time_string, num, CHEESE_VIDEO_NAME_SUFFIX);
 201         break;
 202       default:
 203         g_assert_not_reached ();
 204     }
 205
 206     file = g_file_new_for_path (filename);
 207   }
 208
 209   g_free (time_string);
 210   g_object_unref (file);
 211
 212   return filename;
 213 }
 214
 215 /**
 216  * cheese_fileutil_reset_burst:
 217  * @fileutil: a #CheeseFileUtil
 218  *
 219  * Resets the burst counter, so that calling
 220  * cheese_fileutil_get_new_media_filename() with a photo burst starts a new
 221  * burst of photos.
 222  */
 223 void
 224 cheese_fileutil_reset_burst (CheeseFileUtil *fileutil)
 225 {
 226   CheeseFileUtilPrivate *priv;
 227
 228   g_return_if_fail (CHEESE_IS_FILEUTIL (fileutil));
 229
 230     priv = cheese_fileutil_get_instance_private (fileutil);
 231
 232   priv->burst_count    = 0;
 233   g_free (priv->burst_raw_name);
 234   priv->burst_raw_name = g_strdup ("");
 235 }
 236
 237 static void
 238 cheese_fileutil_finalize (GObject *object)
 239 {
 240   CheeseFileUtil *fileutil = CHEESE_FILEUTIL (object);
 241     CheeseFileUtilPrivate *priv = cheese_fileutil_get_instance_private (fileutil);;
 242
 243   g_free (priv->video_path);
 244   g_free (priv->photo_path);
 245   g_free (priv->burst_raw_name);
 246   G_OBJECT_CLASS (cheese_fileutil_parent_class)->finalize (object);
 247 }
 248
 249 static void
 250 cheese_fileutil_class_init (CheeseFileUtilClass *klass)
 251 {
 252   GObjectClass *object_class = G_OBJECT_CLASS (klass);
 253
 254   object_class->finalize = cheese_fileutil_finalize;
 255 }
 256
 257 static void
 258 cheese_fileutil_init (CheeseFileUtil *fileutil)
 259 {
 260     CheeseFileUtilPrivate *priv = cheese_fileutil_get_instance_private (fileutil);
 261
 262     GSettings *settings;
 263
 264     priv->burst_count = 0;
 265     priv->burst_raw_name = g_strdup ("");
 266
 267     settings = g_settings_new ("org.gnome.Cheese");
 268
 269     priv->video_path = g_settings_get_string (settings, "video-path");
 270     priv->photo_path = g_settings_get_string (settings, "photo-path");
 271
 272     /* Get the video path from GSettings, XDG or hardcoded. */
 273     if (!priv->video_path || !*priv->video_path)
 274     {
 275         const gchar *video_path;
 276
 277         video_path = g_get_user_special_dir (G_USER_DIRECTORY_VIDEOS);
 278         g_free (priv->video_path);
 279
 280         /* Get XDG. */
 281         if (video_path)
 282         {
 283             priv->video_path = g_build_filename (video_path, _("Webcam"), NULL);
 284         }
 285         else
 286         {
 287             /* Get "~/.gnome2/cheese/media". */
 288             priv->video_path = cheese_fileutil_get_path_before_224 (fileutil);
 289         }
 290     }
 291
 292     /* Get the photo path from GSettings, XDG or hardcoded. */
 293     if (!priv->photo_path || !*priv->photo_path)
 294     {
 295         const gchar *photo_path;
 296
 297         photo_path = g_get_user_special_dir (G_USER_DIRECTORY_PICTURES);
 298         g_free (priv->photo_path);
 299
 300         /* Get XDG. */
 301         if (photo_path)
 302         {
 303             priv->photo_path = g_build_filename (photo_path, _("Webcam"), NULL);
 304         }
 305         else
 306         {
 307             /* Get "~/.gnome2/cheese/media". */
 308             priv->photo_path = cheese_fileutil_get_path_before_224 (fileutil);
 309         }
 310     }
 311
 312     g_object_unref (settings);
 313 }
 314
 315 /**
 316  * cheese_fileutil_new:
 317  *
 318  * Create a new #CheeseFileUtil object.
 319  *
 320  * Returns: a new #CheeseFileUtil
 321  */
 322 CheeseFileUtil *
 323 cheese_fileutil_new (void)
 324 {
 325   static CheeseFileUtil *fileutil = NULL;
 326
 327   if (fileutil != NULL)
 328     return g_object_ref (fileutil);
 329
 330   fileutil = g_object_new (CHEESE_TYPE_FILEUTIL, NULL);
 331   g_object_add_weak_pointer (G_OBJECT (fileutil),
 332                              (gpointer) & fileutil);
 333   return fileutil;
 334 }