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  */
 117 public class AddressbookApplication extends BaseFrameworkSystem implements Application {
 118
 119         /**
 120          * Application title
 121          */
 122         public static final String APP_TITLE = "Adressbuch"; //NOI18N
 123
 124         /**
 125          * Application version
 126          */
 127         public static final String APP_VERSION = "0.0"; //NOI18N
 128
 129         /**
 130          * Self instance
 131          */
 132         private static Application selfInstance;
 133
 134         /**
 135          * Console client is enabled by default
 136          */
 137         private boolean consoleClient = true;
 138
 139         /**
 140          * GUI client is disabled by default
 141          */
 142         private boolean guiClient = false;
 143
 144         /**
 145          * Protected constructor
 146          */
 147         protected AddressbookApplication () {
 148                 // Set own instance
 149                 selfInstance = this;
 150         }
 151
 152         /**
 153          * Getter for printable application name
 154          *
 155          * @return A printable name
 156          */
 157         public static String printableTitle () {
 158                 return MessageFormat.format("{0} v{1}", APP_TITLE, APP_VERSION); //NOI18N
 159         }
 160
 161         /**
 162          * Bootstraps application
 163          */
 164         @Override
 165         public void doBootstrap () {
 166                 this.getLogger().debug("Initializing application ..."); //NOI18N
 167
 168                 // Init client variable
 169                 Client client = null;
 170
 171                 // Is console or Swing choosen?
 172                 if (this.isConsole()) {
 173                         // Debug message
 174                         this.getLogger().debug("Initializing console client ..."); //NOI18N
 175
 176                         // Init console client instance
 177                         client = new ConsoleClient(this);
 178                 } else if (this.isGui()) {
 179                         // Debug message
 180                         this.getLogger().debug("Initializing GUI (Swing) client ..."); //NOI18N
 181
 182                         // Init console instance
 183                         client = new SwingClient(this);
 184                 } else {
 185                         // Not client choosen
 186                         this.getLogger().error("No client choosen. Cannot launch."); //NOI18N
 187                         System.exit(1);
 188                 }
 189
 190                 // Init client
 191                 client.init();
 192
 193                 // Set client instance
 194                 this.setClient(client);
 195
 196                 // The application is running at this point
 197                 this.getClient().enableIsRunning();
 198
 199                 // Trace message
 200                 this.getLogger().trace("EXIT!"); //NOI18N
 201         }
 202
 203         /**
 204          * Main loop of the application
 205          */
 206         @Override
 207         public void doMainLoop () {
 208                 // Debug message
 209                 this.getLogger().trace("CALLED!"); //NOI18N
 210
 211                 // @TODO The application should be running now
 212                 // Output introduction
 213                 this.showIntro();
 214
 215                 // Set current menu to main
 216                 this.getClient().setCurrentMenu("main"); //NOI18N
 217
 218                 // --- Main loop starts here ---
 219                 while (this.getClient().isRunning()) {
 220                         // The application is still active, show menu selection
 221                         this.getClient().showCurrentMenu();
 222
 223                         try {
 224                                 // Ask for user input and run proper method
 225                                 this.getClient().doUserMenuChoice();
 226                         } catch (final UnhandledUserChoiceException ex) {
 227                                 this.getLogger().catching(ex);
 228                         }
 229
 230                         try {
 231                                 // Sleep a little to reduce system load
 232                                 Thread.sleep(100);
 233                         } catch (final InterruptedException ex) {
 234                                 // Ignore it
 235                         }
 236                 }
 237                 // --- Main loop ends here ---
 238
 239                 // Debug message
 240                 this.getLogger().debug("Main loop exit - shutting down ..."); //NOI18N
 241         }
 242
 243         /**
 244          * Enables console client by setting propper flag
 245          */
 246         private void enableConsoleClient () {
 247                 this.getLogger().debug("Enabling console client (may become optional client) ..."); //NOI18N
 248                 this.consoleClient = true;
 249                 this.guiClient = false;
 250         }
 251
 252         /**
 253          * Enables GUI client by setting propper flag
 254          */
 255         private void enableGuiClient () {
 256                 this.getLogger().debug("Enabling GUI client (may become new default client) ..."); //NOI18N
 257                 this.consoleClient = false;
 258                 this.guiClient = true;
 259         }
 260
 261         /**
 262          * Checks whether the client shoule be console client should be launched by
 263          * checking if -console is set.
 264          *
 265          * @return Whether console client should be taken
 266          */
 267         private boolean isConsole () {
 268                 return this.consoleClient;
 269         }
 270
 271         /**
 272          * Checks whether the client shoule be GUI client should be launched by
 273          * checking if -gui is set.
 274          *
 275          * @return Whether GUI client should be taken
 276          */
 277         private boolean isGui () {
 278                 return this.guiClient;
 279         }
 280
 281         /**
 282          * Parses all given arguments
 283          *
 284          * @param args Arguments from program launch
 285          */
 286         private void parseArguments (final String[] args) {
 287                 // Trace message
 288                 this.getLogger().trace(MessageFormat.format("args()={0} - CALLED!", args.length)); //NOI18N
 289
 290                 // Debug message
 291                 this.getLogger().debug(MessageFormat.format("Parsing {0} arguments ...", args.length)); //NOI18N
 292
 293                 for (final String arg : args) {
 294                         // Switch on it
 295                         switch (arg) {
 296                                 case "-console": //NOI18N
 297                                         enableConsoleClient();
 298                                         break;
 299
 300                                 case "-gui": //NOI18N
 301                                         enableGuiClient();
 302                                         break;
 303                         }
 304                 }
 305         }
 306
 307         /**
 308          * Show introduction which depends on client
 309          */
 310         private void showIntro () {
 311                 // Trace message
 312                 this.getLogger().trace("CALLED!"); //NOI18N
 313
 314                 // Let the client show it
 315                 this.getClient().showWelcome();
 316
 317                 // Trace message
 318                 this.getLogger().trace("EXIT!"); //NOI18N
 319         }
 320
 321         /**
 322          * Launches the application
 323          *
 324          * @param args Arguments handled to program
 325          */
 326         private void start (final String args[]) {
 327                 this.getLogger().info("Program is started."); //NOI18N
 328
 329                 // Parse arguments
 330                 this.parseArguments(args);
 331
 332                 // Launch application
 333                 ApplicationManager.getManager(this).start();
 334
 335                 // Good bye, but this should not be reached ...
 336                 this.getLogger().warn("Unusual exit reached."); //NOI18N
 337                 this.doShutdown();
 338         }
 339
 340         /**
 341          * Main method (entry point)
 342          *
 343          * @param args the command line arguments
 344          */
 345         public static void main (String[] args) {
 346                 // Start application
 347                 new AddressbookApplication().start(args);
 348         }
 349
 350         /**
 351          * Shuts down the application.
 352          */
 353         @Override
 354         public void doShutdown () {
 355                 // Trace message
 356                 this.getLogger().trace("CALLED!"); //NOI18N
 357
 358                 // Shutdown client
 359                 this.getClient().doShutdown();
 360
 361                 this.getLogger().info("End of program (last line)"); //NOI18N
 362                 System.exit(0);
 363         }
 364
 365         /**
 366          * Getter for this application
 367          *
 368          * @return Instance from this application
 369          */
 370         public static final Application getInstance () {
 371                 // Return it
 372                 return selfInstance;
 373         }
 374 }