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