src/Widgets/gmpc-profiles.vala

   1 /* Gnome Music Player Client (GMPC)
   2  * Copyright (C) 2004-2012 Qball Cow <qball@gmpclient.org>
   3  * Copyright (C) 2012 Quentin "Sardem FF7" Glidic
   4  * Project homepage: http://gmpclient.org/
   5
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; if not, write to the Free Software Foundation, Inc.,
  18  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19 */
  20
  21 private const string some_unique_name_prfs = Config.VERSION;
  22
  23 namespace Gmpc
  24 {
  25     private class Profile
  26     {
  27         public string id              = null;
  28         public string name            = null;
  29         public string hostname        = "localhost";
  30         public int    port            = 6600;
  31         public bool   do_auth         = false;
  32         public string password        = "";
  33         public string music_directory = null;
  34         public int    db_update_time  = 0;
  35     }
  36
  37     public class Profiles : GLib.Object
  38     {
  39         const string LOG_DOMAIN = "Profiles";
  40
  41         public enum Action
  42         {
  43             ADDED,
  44             REMOVED,
  45             COL_CHANGED,
  46             CURRENT
  47         }
  48
  49         public enum Column
  50         {
  51             NAME,
  52             HOSTNAME,
  53             PORT,
  54             DO_AUTH,
  55             PASSWORD,
  56             MUSIC_DIRECTORY,
  57             DB_UPDATE_TIME,
  58             NUM_COLS
  59         }
  60
  61         private Settings profiles;
  62         private GLib.HashTable<string, Profile> list;
  63
  64
  65         public
  66         uint
  67         get_number_of_profiles()
  68         {
  69             return this.list.size();
  70         }
  71
  72         /* Connect on button press event */
  73         private
  74         void
  75         connect_to_profile_button(Gtk.Button button)
  76         {
  77             string id = button.get_data("profile-id");
  78             if(id != null)
  79             {
  80                 this.set_current(id);
  81                 MpdInteraction.disconnect();
  82                 MpdInteraction.connect();
  83             }
  84         }
  85
  86         public signal void changed(int changed, int col, string id);
  87         void
  88         changed_internal(Action changed, Column col, string id)
  89         {
  90             switch (changed)
  91             {
  92                 case Action.ADDED:
  93                     var connect_button = new Gtk.Button.from_stock(Gtk.Stock.CONNECT);
  94                     string message = GLib.Markup.printf_escaped("<b>%s:</b> '%s'", _("Added profile"), this.get_name(id));
  95                     Gmpc.Messages.show(message, Gmpc.Messages.Level.INFO);
  96
  97                     connect_button.set_data_full("profile-id", id, GLib.free);
  98                     connect_button.clicked.connect(this.connect_to_profile_button);
  99                     Gmpc.Messages.add_widget(connect_button);
 100
 101                     GLib.log(LOG_DOMAIN, GLib.LogLevelFlags.LEVEL_DEBUG,"Item %s added\n", id);
 102                     break;
 103                 case Action.REMOVED:
 104                     GLib.log(LOG_DOMAIN, GLib.LogLevelFlags.LEVEL_DEBUG,"Item %s removed\n", id);
 105                     break;
 106                 case Action.COL_CHANGED:
 107                     /* Disabled because of grand spamming charges */
 108                     /*
 109                     stringmessage = GLib.Markup.printf_escaped("<b>%s:</b> '%s'", _("Changed profile"),this.get_name(id));
 110                     Gmpc.Messages.show(message, ERROR_INFO);
 111                     q_free(message);
 112                     */
 113                     GLib.log(LOG_DOMAIN, GLib.LogLevelFlags.LEVEL_DEBUG,"Item %s changed col: %i\n", id, col);
 114                     break;
 115                 case Action.CURRENT:
 116                     break;
 117             }
 118             this.changed(changed, col, id);
 119         }
 120
 121
 122         construct
 123         {
 124             this.list = new GLib.HashTable<string, Profile>(GLib.str_hash, GLib.str_equal);
 125             string url;
 126             /**
 127              * Get Profile
 128              */
 129             url = Gmpc.user_path("profiles.cfg");
 130             this.profiles = new Gmpc.Settings.from_file(url);
 131             if(this.profiles == null)
 132             {
 133                 /**
 134                  * Show gtk error message and quit
 135                  */
 136                 GLib.log(LOG_DOMAIN, GLib.LogLevelFlags.LEVEL_ERROR,"Failed to save/load Profile file:\n%s\n",url);
 137                 Gtk.main_quit();
 138             }
 139             this.load_from_config();
 140             if(this.list.size() == 0)
 141             {
 142                 this.add_default();
 143                 this.load_from_config();
 144             }
 145         }
 146
 147         /**
 148          * Add default values
 149          */
 150         private
 151         void
 152         add_default()
 153         {
 154             Gmpc.config.set_string("connection", "currentprofile", "Default");
 155             this.profiles.set_string("Default", "hostname", "localhost");
 156             this.profiles.set_string("Default", "name", "Default");
 157             this.profiles.set_string("Default", "password", "");
 158             this.profiles.set_int("Default", "portnumber", 6600);
 159             this.profiles.set_bool("Default", "useauth", false);
 160             this.profiles.set_string("Default", "music directory", "");
 161         }
 162
 163         private
 164         void
 165         load_from_config()
 166         {
 167             SettingsList list = this.profiles.get_class_list();
 168             for (unowned SettingsList iter = list ; iter != null ; iter = iter.next)
 169             {
 170                 Profile prof = new Profile();
 171
 172                 prof.id = iter.key;
 173                 prof.name = this.profiles.get_string(prof.id, "name");
 174                 prof.hostname = this.profiles.get_string(prof.id, "hostname");
 175                 prof.password = this.profiles.get_string(prof.id, "password");
 176                 prof.port = this.profiles.get_int(prof.id, "portnumber");
 177                 prof.do_auth = this.profiles.get_bool(prof.id, "useauth");
 178
 179                 prof.music_directory = this.profiles.get_string(prof.id, "music directory");
 180                 prof.db_update_time = this.profiles.get_int_with_default(prof.id, "db update time", 0);
 181
 182                 this.list.insert(prof.id, prof);
 183             }
 184         }
 185
 186         /**
 187          * get hostname
 188          */
 189         public
 190         string?
 191         get_hostname(string id)
 192         {
 193             Profile prof = this.list.lookup(id);
 194             if(prof == null)
 195                 return null;
 196             return prof.hostname;
 197         }
 198         /**
 199          * get name
 200          */
 201         public
 202         unowned string?
 203         get_name(string id)
 204         {
 205             Profile prof = this.list.lookup(id);
 206             if(prof == null)
 207               return null;
 208             return prof.name;
 209         }
 210         /**
 211          * get id
 212          */
 213         public
 214         unowned string?
 215         get_id(string id)
 216         {
 217             Profile prof = this.list.lookup(id);
 218             if(prof == null)
 219                 return null;
 220             return prof.id;
 221         }
 222         /**
 223          * get password
 224          */
 225         public
 226         unowned string?
 227         get_password(string id)
 228         {
 229             Profile prof = this.list.lookup(id);
 230             if(prof == null)
 231                 return null;
 232             return prof.password;
 233         }
 234
 235         /**
 236          * get music directory
 237          */
 238         public
 239         unowned string?
 240         get_music_directory(string id)
 241         {
 242             Profile prof = this.list.lookup(id);
 243             if(prof == null)
 244                 return null;
 245             return prof.music_directory;
 246         }
 247         /**
 248          * get music directory
 249          */
 250         public
 251         int
 252         get_db_update_time(string id)
 253         {
 254             Profile prof = this.list.lookup(id);
 255             if(prof == null)
 256                 return 0;
 257             return prof.db_update_time;
 258         }
 259         /**
 260          * get port
 261          */
 262         public
 263         int
 264         get_port(string id)
 265         {
 266             Profile prof = this.list.lookup(id);
 267             if(prof == null)
 268                 return -1;
 269             return prof.port;
 270         }
 271
 272         /**
 273          * get do_auth
 274          */
 275         public
 276         bool
 277         get_do_auth(string id)
 278         {
 279             Profile prof = this.list.lookup(id);
 280             if(prof == null)
 281                 return false;
 282             return prof.do_auth;
 283         }
 284
 285         /**
 286         * Create new item
 287         */
 288         public
 289         unowned string
 290         create_new_item(string id)
 291         {
 292             return this.create_new_item_with_name(id, "New Profile");
 293         }
 294
 295         public
 296         unowned string
 297         create_new_item_with_name(string? id, string? name)
 298         {
 299             var prof = new Profile();
 300             if(id == null)
 301                 prof.id = GLib.Random.next_int().to_string();
 302             else
 303                 prof.id = id;
 304             if(name == null)
 305                 prof.name = "New Profile";
 306             else
 307                 prof.name = name;
 308
 309             /* safe this to the config file */
 310             this.profiles.set_string(prof.id, "name", prof.name);
 311             this.profiles.set_string(prof.id, "hostname", prof.hostname);
 312             this.profiles.set_string(prof.id, "password", prof.password);
 313             this.profiles.set_int(prof.id, "portnumber", prof.port);
 314             this.profiles.set_bool(prof.id, "useauth", prof.do_auth);
 315             this.profiles.set_string(prof.id, "music directory", prof.music_directory);
 316
 317             this.profiles.get_int_with_default(prof.id, "db update time",(int)(prof.db_update_time));
 318
 319             this.list.insert(prof.id, prof);
 320
 321             /* propagate */
 322             this.changed_internal(Action.ADDED, Column.NUM_COLS, prof.id);
 323             return prof.id;
 324         }
 325
 326         public
 327         void
 328         remove_item(string id)
 329         {
 330             string message = null;
 331             if(!this.has_profile(id))
 332             {
 333                 GLib.log(LOG_DOMAIN, GLib.LogLevelFlags.LEVEL_WARNING, "Trying to remove not-existing profile: %s\n", id);
 334                 return;
 335             }
 336             /* Generate removal message before the actual profile is destroyed */
 337             message = GLib.Markup.printf_escaped("<b>%s:</b> '%s'", _("Removed profile"),this.get_name(id));
 338
 339             this.list.remove(id);
 340
 341             /* Display the message */
 342             Gmpc.Messages.show(message, Gmpc.Messages.Level.INFO);
 343
 344             this.changed_internal(Action.REMOVED, Column.NUM_COLS, id);
 345         }
 346
 347         /**
 348         * GET CURRENT
 349         */
 350         public
 351         string
 352         get_current()
 353         {
 354             var id = Gmpc.config.get_string_with_default("connection", "currentprofile", "Default");
 355             Profile prof = this.list.lookup(id);
 356             /* if not available get the first one */
 357             if(prof == null)
 358             {
 359                 if(this.list.size() > 0)
 360                 {
 361                     var iter = GLib.HashTableIter<string, Profile>(this.list);
 362                     iter.next(out id, out prof);
 363                     this.set_current(id);
 364                 } else {
 365                     this.add_default();
 366                     this.load_from_config();
 367                     this.changed_internal(Action.ADDED, Column.NUM_COLS, "Default");
 368                 }
 369                 id = Gmpc.config.get_string_with_default("connection", "currentprofile", "Default");
 370             }
 371             return id;
 372         }
 373
 374         public signal void profile_changed(string id);
 375         public void
 376         set_current(string id)
 377         {
 378             if(this.has_profile(id))
 379             {
 380                 Gmpc.config.set_string("connection", "currentprofile", id);
 381
 382                 this.changed_internal(Action.CURRENT, 0, id);
 383             }
 384             this.profile_changed(id);
 385         }
 386
 387         public
 388         GLib.List<weak string>
 389         get_profiles_ids()
 390         {
 391             return this.list.get_keys();
 392         }
 393
 394         /**
 395          * set field
 396          */
 397         public
 398         void
 399         set_name(string id, string @value)
 400         {
 401             Profile prof = this.list.lookup(id);
 402             if(prof == null) return;
 403
 404             if(@value == prof.name) return;
 405             prof.name = @value;
 406
 407             this.profiles.set_string(id, "name", prof.name);
 408             this.changed_internal(Action.COL_CHANGED, Column.NAME, id);
 409         }
 410
 411         public
 412         void
 413         set_hostname(string id, string @value)
 414         {
 415             Profile prof = this.list.lookup(id);
 416             if(prof == null) return;
 417
 418             if(@value == prof.hostname) return;
 419             prof.hostname = @value;
 420
 421             this.profiles.set_string(id, "hostname", prof.hostname);
 422             this.changed_internal(Action.COL_CHANGED, Column.HOSTNAME, id);
 423         }
 424
 425         /**
 426          * Set Password
 427          */
 428         public
 429         void
 430         set_password(string id, string? @value)
 431         {
 432             Profile prof = this.list.lookup(id);
 433             if(prof == null) return;
 434
 435             if(@value == prof.password) return;
 436             prof.password = (@value != null) ? @value : "";
 437
 438             this.profiles.set_string(id, "password", prof.password);
 439             this.changed_internal(Action.COL_CHANGED, Column.PASSWORD, id);
 440         }
 441
 442         /**
 443          * Set Port
 444          */
 445         public
 446         void
 447         set_port(string id, int @value)
 448         {
 449             Profile prof = this.list.lookup(id);
 450             if(prof == null) return;
 451
 452             if(value == prof.port) return;
 453             prof.port = @value;
 454
 455             this.profiles.set_int(id, "portnumber",prof.port);
 456             this.changed_internal(Action.COL_CHANGED, Column.PORT, id);
 457         }
 458
 459         /**
 460          * Set music directory
 461          */
 462         public
 463         void
 464         set_music_directory(string id, string @value)
 465         {
 466             Profile prof = this.list.lookup(id);
 467             if(prof == null) return;
 468
 469             if(@value == prof.music_directory) return;
 470             prof.music_directory = (@value != null) ? @value : "";
 471
 472             this.profiles.set_string(id, "music directory", prof.music_directory);
 473             this.changed_internal(Action.COL_CHANGED, Column.MUSIC_DIRECTORY,id);
 474         }
 475
 476
 477         public
 478         void
 479         set_db_update_time(string id, int @value)
 480         {
 481             Profile prof = this.list.lookup(id);
 482             if(prof == null) return;
 483
 484             if(@value == prof.db_update_time) return;
 485             prof.db_update_time = @value;
 486
 487             this.profiles.set_int(id, "db update time", @value);
 488             this.changed_internal(Action.COL_CHANGED, Column.DB_UPDATE_TIME, id);
 489         }
 490
 491         /**
 492          * Set do auth
 493          */
 494         public
 495         void
 496         set_do_auth(string id, bool @value)
 497         {
 498             Profile prof = this.list.lookup(id);
 499             if(prof == null) return;
 500
 501             if(prof.do_auth == @value) return;
 502             prof.do_auth = @value;
 503
 504             this.profiles.set_bool(id, "useauth", prof.do_auth);
 505             this.changed_internal(Action.COL_CHANGED, Column.DO_AUTH, id);
 506         }
 507
 508         /**
 509          * Has profile with id
 510          */
 511         public
 512         bool
 513         has_profile(string id)
 514         {
 515             return ( this.list.lookup(id) != null );
 516         }
 517
 518         public
 519         void
 520         set_profile_from_name(string name)
 521         {
 522             var prof = this.list.find((id, prof) => {
 523                 return (name == prof.name);
 524             });
 525             MpdInteraction.set_current_profile(prof.id);
 526         }
 527     }
 528 }