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