src/plugins/rssyl/rssyl_update_format.c

   1 /*
   2  * Copyright (C) 2006 Andrej Kacian <andrej@kacian.sk>
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU General Public License as
   6  * published by the Free Software Foundation; either version 2 of the
   7  * License, or (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public
  15  * License along with this program; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 #ifdef HAVE_CONFIG_H
  21 #  include "config.h"
  22 #endif
  23
  24 /* Global includes */
  25 #include <glib/gi18n.h>
  26 #include <gtk/gtk.h>
  27
  28 /* Claws Mail includes */
  29 #include <alertpanel.h>
  30 #include <log.h>
  31 #include <mainwindow.h>
  32
  33 /* Local includes */
  34 #include "old_feeds.h"
  35 #include "rssyl.h"
  36 #include "rssyl_feed.h"
  37 #include "strutils.h"
  38
  39 struct _RUpdateFormatCtx {
  40         FolderItem *o_prev;
  41         FolderItem *o_parent;
  42         FolderItem *n_prev;
  43         FolderItem *n_parent;
  44         Folder *n_first;
  45         GSList *oldfeeds;
  46         GSList *oldroots;
  47         gboolean reached_first_new;
  48 };
  49
  50 typedef struct _RUpdateFormatCtx RUpdateFormatCtx;
  51
  52 extern FolderClass rssyl_class;
  53
  54 static void rssyl_update_format_move_contents(FolderItem *olditem,
  55                 FolderItem *newitem);
  56 static gchar *_old_rssyl_item_get_path(Folder *folder, FolderItem *item);
  57 static void _delete_old_roots_func(gpointer data, gpointer user_data);
  58
  59 static void rssyl_update_format_func(FolderItem *item, gpointer data)
  60 {
  61         RFolderItem *ritem;
  62         RUpdateFormatCtx *ctx = (RUpdateFormatCtx *)data;
  63         Folder *f = NULL;
  64         FolderItem *new_item = NULL;
  65         gchar *name;
  66         OldRFeed *of;
  67
  68         if( !IS_RSSYL_FOLDER_ITEM(item) )
  69                 return;
  70
  71         /* Do not do anything once we reached first new folder
  72          * (which we created earlier in this process) */
  73         if( ctx->reached_first_new )
  74                 return;
  75
  76         if( item->folder == ctx->n_first ) {
  77                 ctx->reached_first_new = TRUE;
  78                 debug_print("RSSyl: (FORMAT) reached first new folder\n");
  79                 return;
  80         }
  81
  82         debug_print("RSSyl: (FORMAT) item '%s'\n", item->name);
  83
  84         if( folder_item_parent(item) == NULL ) {
  85                 /* Root rssyl folder */
  86                 ctx->oldroots = g_slist_prepend(ctx->oldroots, item);
  87
  88                 /* Create its counterpart */
  89                 name = rssyl_strreplace(folder_item_get_name(item), " (RSSyl)", "");
  90                 debug_print("RSSyl: (FORMAT) adding new root folder '%s'\n", name);
  91                 f = folder_new(rssyl_folder_get_class(), name, NULL);
  92                 g_free(name);
  93                 g_return_if_fail(f != NULL);
  94                 folder_add(f);
  95
  96                 folder_write_list();
  97
  98                 new_item = FOLDER_ITEM(f->node->data);
  99
 100                 /* If user has more than one old rssyl foldertrees, keep the n_first
 101                  * pointer at the beginning of first one. */
 102                 if (ctx->n_first == NULL)
 103                         ctx->n_first = f;
 104
 105                 ctx->n_parent = new_item;
 106         } else {
 107                 /* Non-root folder */
 108
 109                 if (folder_item_parent(item) == ctx->o_prev) {
 110                         /* We went one step deeper in folder hierarchy, adjust pointers
 111                          * to parents */
 112                         ctx->o_parent = ctx->o_prev;
 113                         ctx->n_parent = ctx->n_prev;
 114                 } else if (folder_item_parent(item) != ctx->o_parent) {
 115                         /* We are not in same folder anymore, which can only mean we have
 116                          * moved up in the hierarchy. Find a correct parent */
 117                         while (folder_item_parent(item) != ctx->o_parent) {
 118                                 ctx->o_parent = folder_item_parent(ctx->o_parent);
 119                                 ctx->n_parent = folder_item_parent(ctx->n_parent);
 120                                 if (ctx->o_parent == NULL) {
 121                                         /* This shouldn't happen, unless we are magically moved to a
 122                                          * completely different folder structure */
 123                                         debug_print("RSSyl: MISHAP WHILE UPGRADING STORAGE FORMAT: couldn't find folder parent\n");
 124                                         alertpanel_error(_("Internal problem while upgrading storage format. This should not happen. Please report this, with debug output attached.\n"));
 125                                         return;
 126                                 }
 127                         }
 128                 } else {
 129                         /* We have remained in the same subfolder, nothing to do here */
 130                 }
 131
 132                 debug_print("RSSyl: (FORMAT) adding folder '%s'\n", item->name);
 133                 new_item = folder_create_folder(ctx->n_parent, item->name);
 134
 135                 if (new_item == NULL) {
 136                         debug_print("RSSyl: (FORMAT) couldn't add folder '%s', skipping it\n",
 137                                         item->name);
 138                         return;
 139                 }
 140
 141                 of = rssyl_old_feed_get_by_name(ctx->oldfeeds, item->name);
 142                 if (of != NULL && of->url != NULL) {
 143                         /* Folder with an actual subscribed feed */
 144                         debug_print("RSSyl: (FORMAT) making '%s' a feed with URL '%s'\n",
 145                                         item->name, of->url);
 146
 147                         ritem = (RFolderItem *)new_item;
 148                         ritem->url = g_strdup(of->url);
 149
 150                         rssyl_feed_start_refresh_timeout(ritem);
 151
 152                         /* TODO: copy feed preferences from old structure */
 153                         ritem->official_title = g_strdup(of->official_name);
 154                         ritem->default_refresh_interval =
 155                                 (of->default_refresh_interval != 0 ? TRUE : FALSE);
 156                         ritem->refresh_interval = of->refresh_interval;
 157                         ritem->keep_old = (of->expired_num > -1 ? TRUE : FALSE);
 158                         ritem->fetch_comments =
 159                                 (of->fetch_comments != 0 ? TRUE : FALSE);
 160                         ritem->fetch_comments_max_age = of->fetch_comments_for;
 161                         ritem->silent_update = of->silent_update;
 162                         ritem->ssl_verify_peer = of->ssl_verify_peer;
 163                 }
 164
 165                 rssyl_update_format_move_contents(item, new_item);
 166
 167                 /* destroy the new folder's cache so we'll re-read the migrated one */
 168                 if (new_item->cache) {
 169                         msgcache_destroy(new_item->cache);
 170                         new_item->cache = NULL;
 171                 }
 172
 173                 /* Store folderlist with the new folder */
 174                 folder_item_scan(new_item);
 175                 folder_write_list();
 176         }
 177
 178         ctx->o_prev = item;
 179         ctx->n_prev = new_item;
 180 }
 181
 182
 183 void rssyl_update_format()
 184 {
 185         RUpdateFormatCtx *ctx = NULL;
 186         GSList *oldfeeds;
 187         gchar *old_feeds_xml = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S,
 188                         RSSYL_DIR, G_DIR_SEPARATOR_S, "feeds.xml", NULL);
 189
 190         if (!g_file_test(old_feeds_xml,
 191                                 G_FILE_TEST_EXISTS | G_FILE_TEST_IS_REGULAR)) {
 192                 g_free(old_feeds_xml);
 193                 return;
 194         }
 195
 196         debug_print("RSSyl: Old format found, updating.\n");
 197
 198         oldfeeds = rssyl_old_feed_metadata_parse(old_feeds_xml);
 199
 200         /* We find all rssyl root folders and perform magic on each */
 201         ctx = g_new0(RUpdateFormatCtx, 1);
 202         ctx->o_prev = NULL;
 203         ctx->o_parent = NULL;
 204         ctx->n_prev = NULL;
 205         ctx->n_parent = NULL;
 206         ctx->n_first = NULL;
 207         ctx->oldfeeds = oldfeeds;
 208         ctx->oldroots = NULL;
 209         ctx->reached_first_new = FALSE;
 210
 211         folder_item_update_freeze();
 212
 213         /* Go through all RSSyl folders, making new copies */
 214         folder_func_to_all_folders((FolderItemFunc)rssyl_update_format_func, ctx);
 215
 216         g_slist_foreach(ctx->oldroots, _delete_old_roots_func, NULL);
 217         g_slist_free(ctx->oldroots);
 218
 219         folder_item_update_thaw();
 220
 221         g_free(ctx);
 222
 223         g_remove(old_feeds_xml);
 224         g_free(old_feeds_xml);
 225 }
 226
 227 static void _delete_old_roots_func(gpointer data, gpointer user_data)
 228 {
 229         FolderItem *item = (FolderItem *)data;
 230
 231         folder_destroy(item->folder);
 232 }
 233
 234 /* Copy each item in a feed to the new directory */
 235 static void rssyl_update_format_move_contents(FolderItem *olditem,
 236                 FolderItem *newitem)
 237 {
 238         gchar *oldpath, *newpath, *fname, *fpath, *nfpath;
 239         GDir *d = NULL;
 240         GError *error = NULL;
 241
 242         oldpath = _old_rssyl_item_get_path(NULL, olditem);
 243         newpath = folder_item_get_path(newitem);
 244
 245         if ((d = g_dir_open(oldpath, 0, &error)) == NULL) {
 246                 debug_print("RSSyl: (FORMAT) couldn't open dir '%s': %s\n", oldpath,
 247                                 error->message);
 248                 g_error_free(error);
 249                 return;
 250         }
 251
 252         debug_print("RSSyl: (FORMAT) moving contents of '%s' to '%s'\n",
 253                         oldpath, newpath);
 254
 255         while ((fname = (gchar *)g_dir_read_name(d)) != NULL) {
 256                 gboolean migrate_file = to_number(fname) > 0 || strstr(fname, ".claws_") == fname;
 257                 fpath = g_strconcat(oldpath, G_DIR_SEPARATOR_S, fname, NULL);
 258                 if (migrate_file && g_file_test(fpath, G_FILE_TEST_IS_REGULAR)) {
 259                         nfpath = g_strconcat(newpath, G_DIR_SEPARATOR_S, fname, NULL);
 260                         move_file(fpath, nfpath, FALSE);
 261                         g_free(nfpath);
 262                 }
 263                 g_remove(fpath);
 264                 g_free(fpath);
 265         }
 266
 267         g_dir_close(d);
 268         g_rmdir(oldpath);
 269
 270         g_free(oldpath);
 271         g_free(newpath);
 272 }
 273
 274 static gchar *_old_rssyl_item_get_path(Folder *folder, FolderItem *item)
 275 {
 276         gchar *result, *tmp;
 277
 278         if (folder_item_parent(item) == NULL)
 279                 return g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, RSSYL_DIR, NULL);
 280
 281         tmp = rssyl_strreplace(item->name, "/", "\\");
 282         result = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, RSSYL_DIR,
 283                         G_DIR_SEPARATOR_S, tmp, NULL);
 284         g_free(tmp);
 285         return result;
 286 }