Addressbook/src/org/mxchange/addressbook/application/AddressbookApplication.java

   1 /*
   2  * Copyright (C) 2015 Roland Haeder
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 3 of the License, or
   7  * (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
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17 package org.mxchange.addressbook.application;
  18
  19 import java.text.MessageFormat;
  20 import org.mxchange.addressbook.BaseFrameworkSystem;
  21 import org.mxchange.addressbook.client.Client;
  22 import org.mxchange.addressbook.client.console.ConsoleClient;
  23 import org.mxchange.addressbook.client.gui.SwingClient;
  24 import org.mxchange.addressbook.exceptions.UnhandledUserChoiceException;
  25 import org.mxchange.addressbook.manager.application.ApplicationManager;
  26
  27 /**
  28  * ============================================
  29  * AddressbookApplication management:
  30  * ============================================
  31  *
  32  * Inernet("public" service) and Intranet
  33  *
  34  * Version 1.0+:
  35  * - Single-user local application
  36  * - Fields:
  37  *   + Gender
  38  *   + Surname
  39  *   + Family name
  40  *   + Company name
  41  *   + Street + number
  42  *   + ZIP code
  43  *   + City
  44  *   + Landline number
  45  *   + Fax number
  46  *   + Cell phone number
  47  *   + Email address
  48  *   + Birth day
  49  *   + Comment (?)
  50  * - Edit own data
  51  * - Add new contact
  52  * - Edit contacts
  53  * - Delete contacts
  54  * - Categorization of contacts
  55  *
  56  * Version 1.1+:
  57  * - Permanent storage in database
  58  *
  59  * Version 2.0+:
  60  * - Multi-user web application
  61  * - Local user registration / login / resend confirmation link / password
  62  *   recovery
  63  * - User groups (aka. teams)
  64  * - Administration area (user role)
  65  *   + Create/edit/delete groups
  66  *   + Edit/delete/lock/unlock user
  67  *   + Assign user roles/rights
  68  * - Allow other users / groups to view addressbook
  69  *   + Full addressbook
  70  *   + Only some categories
  71  * - VCard export
  72  *   + Allow users/guests (not recommended)
  73  * - XML export of addressbook and compressable (ZIP)
  74  * - Form to contact other user/group without need of mail program
  75  *   + User can disabled this
  76  * - Directory for ussers/groups (who allowed to be listed)
  77  *   + Simple click to add user to own addressbook
  78  *   + Search form?
  79  *
  80  * Version 2.1+:
  81  * - Multi-language support
  82  *
  83  * Version 2.2+:("socialized")
  84  * - "Social login" (OpenID consumer)
  85  *   + Connect user account to social account
  86  *   + Sync own data?
  87  * - "Social profile"
  88  *   + OpenID provider
  89  *   + RSS/activity feed
  90  *
  91  * ============================================
  92  * Time esitmation:
  93  * ============================================
  94  * 1.0 (console):
  95  *   + 2 days
  96  *
  97  * 1.1 (database):
  98  *   + 2 day
  99  *   + Initial tables: contacts, categories, contact_category
 100  *
 101  * 2.0 (web):
 102  *   + 3 days
 103  *   + Additional tables: admins (?), admin_rights, groups,
 104  *    users, user_contacts, user_user_rights, user_category_rights,
 105  *
 106  * 2.1 (language)
 107  *   + 1 day
 108  *   + Additional tables: languages (disable, enable language "pack" ?)
 109  *
 110  * 2.2 (social):
 111  *   + 3 days
 112  *   + Additional tables: ???
 113  *
 114  * @author Roland Haeder
 115  * @version 0.0
 116  * @since 0.0
 117  */
 118 public class AddressbookApplication extends BaseFrameworkSystem implements Application {
 119
 120         /**
 121          * Application title
 122          */
 123         public static final String APP_TITLE = "Adressbuch";
 124
 125         /**
 126          * Application version
 127          */
 128         public static final String APP_VERSION = "0.0";
 129
 130         /**
 131          * Self instance
 132          */
 133         private static Application selfInstance;
 134
 135         /**
 136          * Console client is enabled by default
 137          */
 138         private boolean consoleClient = true;
 139
 140         /**
 141          * GUI client is disabled by default
 142          */
 143         private boolean guiClient = false;
 144
 145         /**
 146          * Protected constructor
 147          */
 148         protected AddressbookApplication () {
 149                 // Set own instance
 150                 selfInstance = this;
 151         }
 152
 153         /**
 154          * Getter for printable application name
 155          *
 156          * @return A printable name
 157          */
 158         public static String printableTitle () {
 159                 return MessageFormat.format("{0} v{1}", APP_TITLE, APP_VERSION);
 160         }
 161
 162         /**
 163          * Bootstraps application
 164          */
 165         @Override
 166         public void doBootstrap () {
 167                 this.getLogger().debug("Initializing application ...");
 168
 169                 // Init client variable
 170                 Client client = null;
 171
 172                 // Is console or Swing choosen?
 173                 if (this.isConsole()) {
 174                         // Debug message
 175                         this.getLogger().debug("Initializing console client ...");
 176
 177                         // Init console client instance
 178                         client = new ConsoleClient(this);
 179                 } else if (this.isGui()) {
 180                         // Debug message
 181                         this.getLogger().debug("Initializing GUI (Swing) client ...");
 182
 183                         // Init console instance
 184                         client = new SwingClient(this);
 185                 } else {
 186                         // Not client choosen
 187                         this.getLogger().error("No client choosen. Cannot launch.");
 188                         System.exit(1);
 189                 }
 190
 191                 // Init client
 192                 client.init();
 193
 194                 // Set client instance
 195                 this.setClient(client);
 196
 197                 // The application is running at this point
 198                 this.getClient().enableIsRunning();
 199         }
 200
 201         /**
 202          * Main loop of the application
 203          */
 204         @Override
 205         public void doMainLoop () {
 206                 // Debug message
 207                 this.getLogger().trace("CALLED!");
 208
 209         // @TODO The application should be running now
 210                 // Output introduction
 211                 this.showIntro();
 212
 213                 // Set current menu to main
 214                 this.getClient().setCurrentMenu("main");
 215
 216                 // --- Main loop starts here ---
 217                 while (this.getClient().isRunning()) {
 218                         // The application is still active, show menu selection
 219                         this.getClient().showCurrentMenu();
 220
 221                         try {
 222                                 // Ask for user input and run proper method
 223                                 this.getClient().doUserMenuChoice();
 224                         } catch (final UnhandledUserChoiceException ex) {
 225                                 this.getLogger().catching(ex);
 226                         }
 227
 228                         try {
 229                                 // Sleep a little to reduce system load
 230                                 Thread.sleep(100);
 231                         } catch (final InterruptedException ex) {
 232                                 // Ignore it
 233                         }
 234                 }
 235         // --- Main loop ends here ---
 236
 237                 // Debug message
 238                 this.getLogger().debug("Main loop exit - shutting down ...");
 239         }
 240
 241         /**
 242          * Enables console client by setting propper flag
 243          */
 244         private void enableConsoleClient () {
 245                 this.getLogger().debug("Enabling console client (may become optional client) ...");
 246                 this.consoleClient = true;
 247                 this.guiClient = false;
 248         }
 249
 250         /**
 251          * Enables GUI client by setting propper flag
 252          */
 253         private void enableGuiClient () {
 254                 this.getLogger().debug("Enabling GUI client (may become new default client) ...");
 255                 this.consoleClient = false;
 256                 this.guiClient = true;
 257         }
 258
 259         /**
 260          * Checks whether the client shoule be console client should be launched by
 261          * checking if -console is set.
 262          *
 263          * @return Whether console client should be taken
 264          */
 265         private boolean isConsole () {
 266                 return this.consoleClient;
 267         }
 268
 269         /**
 270          * Checks whether the client shoule be GUI client should be launched by
 271          * checking if -gui is set.
 272          *
 273          * @return Whether GUI client should be taken
 274          */
 275         private boolean isGui () {
 276                 return this.guiClient;
 277         }
 278
 279         /**
 280          * Parses all given arguments
 281          *
 282          * @param args Arguments from program launch
 283          */
 284         private void parseArguments (final String[] args) {
 285                 // Debug message
 286                 this.getLogger().debug(MessageFormat.format("Parsing {0} arguments ...", args.length));
 287
 288                 for (final String arg : args) {
 289                         // Switch on it
 290                         switch (arg) {
 291                                 case "-console":
 292                                         enableConsoleClient();
 293                                         break;
 294
 295                                 case "-gui":
 296                                         enableGuiClient();
 297                                         break;
 298                         }
 299                 }
 300         }
 301
 302         /**
 303          * Show introduction which depends on client
 304          */
 305         private void showIntro () {
 306                 // Let the client show it
 307                 this.getClient().showWelcome();
 308         }
 309
 310         /**
 311          * Launches the application
 312          *
 313          * @param args Arguments handled to program
 314          */
 315         private void start (final String args[]) {
 316                 this.getLogger().info("Program is started.");
 317
 318                 // Parse arguments
 319                 this.parseArguments(args);
 320
 321                 // Launch application
 322                 ApplicationManager.getManager(this).start();
 323
 324                 // Good bye, but this should not be reached ...
 325                 this.getLogger().warn("Unusual exit reached.");
 326                 this.doShutdown();
 327         }
 328
 329         /**
 330          * Main method (entry point)
 331          *
 332          * @param args the command line arguments
 333          */
 334         public static void main (String[] args) {
 335                 // Start application
 336                 new AddressbookApplication().start(args);
 337         }
 338
 339         /**
 340          * Shuts down the application.
 341          */
 342         @Override
 343         public void doShutdown () {
 344                 // Shutdown client
 345                 this.getClient().doShutdown();
 346
 347                 this.getLogger().info("End of program (last line)");
 348                 System.exit(0);
 349         }
 350
 351         /**
 352          * Getter for this application
 353          *
 354          * @return Instance from this application
 355          */
 356         public static final Application getInstance () {
 357                 // Return it
 358                 return selfInstance;
 359         }
 360 }