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.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                 // Init bundle
 153                 this.initBundle();
 154         }
 155
 156         /**
 157          * Bootstraps application
 158          */
 159         @Override
 160         public void doBootstrap () {
 161                 this.getLogger().debug("Initializing application ..."); //NOI18N
 162
 163                 // Init client variable
 164                 Client client = null;
 165
 166                 // Is console or Swing choosen?
 167                 if (this.isConsole()) {
 168                         // Debug message
 169                         this.getLogger().debug("Initializing console client ..."); //NOI18N
 170
 171                         // Init console client instance
 172                         client = new ConsoleClient(this);
 173                 } else if (this.isGui()) {
 174                         // Debug message
 175                         this.getLogger().debug("Initializing GUI (Swing) client ..."); //NOI18N
 176
 177                         // Init console instance
 178                         client = new SwingClient(this);
 179                 } else {
 180                         // Not client choosen
 181                         this.getLogger().error("No client choosen. Cannot launch."); //NOI18N
 182                         System.exit(1);
 183                 }
 184
 185                 // Init client
 186                 client.init();
 187
 188                 // Set client instance
 189                 this.setClient(client);
 190
 191                 // The application is running at this point
 192                 this.getClient().enableIsRunning();
 193
 194                 // Trace message
 195                 this.getLogger().trace("EXIT!"); //NOI18N
 196         }
 197
 198         /**
 199          * Main loop of the application
 200          */
 201         @Override
 202         public void doMainLoop () {
 203                 // Get client and cast it
 204                 AddressbookClient client = (AddressbookClient) this.getClient();
 205
 206                 // Debug message
 207                 this.getLogger().trace("CALLED!"); //NOI18N
 208
 209                 // @TODO The application should be running now
 210                 // Output introduction
 211                 this.showIntro();
 212
 213                 // Set current menu to main
 214                 client.setCurrentMenu("main"); //NOI18N
 215
 216                 // --- Main loop starts here ---
 217                 while (this.getClient().isRunning()) {
 218                         // The application is still active, show menu selection
 219                         client.showCurrentMenu();
 220
 221                         try {
 222                                 // Ask for user input and run proper method
 223                                 client.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 ..."); //NOI18N
 239         }
 240
 241         /**
 242          * Shuts down the application.
 243          */
 244         @Override
 245         public void doShutdown () throws SQLException, IOException {
 246                 // Trace message
 247                 this.getLogger().trace("CALLED!"); //NOI18N
 248
 249                 // Shutdown client
 250                 this.getClient().doShutdown();
 251
 252                 this.getLogger().info("End of program (last line)"); //NOI18N
 253                 System.exit(0);
 254         }
 255
 256         /**
 257          * Enables console client by setting propper flag
 258          */
 259         private void enableConsoleClient () {
 260                 this.getLogger().debug("Enabling console client (may become optional client) ..."); //NOI18N
 261                 this.consoleClient = true;
 262                 this.guiClient = false;
 263         }
 264
 265         /**
 266          * Enables GUI client by setting propper flag
 267          */
 268         private void enableGuiClient () {
 269                 this.getLogger().debug("Enabling GUI client (may become new default client) ..."); //NOI18N
 270                 this.consoleClient = false;
 271                 this.guiClient = true;
 272         }
 273
 274         /**
 275          * Checks whether the client shoule be console client should be launched by
 276          * checking if -console is set.
 277          *
 278          * @return Whether console client should be taken
 279          */
 280         private boolean isConsole () {
 281                 return this.consoleClient;
 282         }
 283
 284         /**
 285          * Checks whether the client shoule be GUI client should be launched by
 286          * checking if -gui is set.
 287          *
 288          * @return Whether GUI client should be taken
 289          */
 290         private boolean isGui () {
 291                 return this.guiClient;
 292         }
 293
 294         /**
 295          * Parses all given arguments
 296          *
 297          * @param args Arguments from program launch
 298          */
 299         private void parseArguments (final String[] args) {
 300                 // Trace message
 301                 this.getLogger().trace(MessageFormat.format("args()={0} - CALLED!", args.length)); //NOI18N
 302
 303                 // Debug message
 304                 this.getLogger().debug(MessageFormat.format("Parsing {0} arguments ...", args.length)); //NOI18N
 305
 306                 for (final String arg : args) {
 307                         // Switch on it
 308                         switch (arg) {
 309                                 case "-console": //NOI18N
 310                                         enableConsoleClient();
 311                                         break;
 312
 313                                 case "-gui": //NOI18N
 314                                         enableGuiClient();
 315                                         break;
 316                         }
 317                 }
 318         }
 319
 320         /**
 321          * Show introduction which depends on client
 322          */
 323         private void showIntro () {
 324                 // Trace message
 325                 this.getLogger().trace("CALLED!"); //NOI18N
 326
 327                 // Let the client show it
 328                 this.getClient().showWelcome();
 329
 330                 // Trace message
 331                 this.getLogger().trace("EXIT!"); //NOI18N
 332         }
 333
 334         /**
 335          * Launches the application
 336          *
 337          * @param args Arguments handled to program
 338          */
 339         private void start (final String args[]) {
 340                 this.getLogger().info("Program is started."); //NOI18N
 341                 try {
 342                         // Init properties file
 343                         this.initProperties();
 344                 } catch (final IOException ex) {
 345                         // Something bad happened
 346                         this.abortProgramWithException(ex);
 347                 }
 348
 349                 // Parse arguments
 350                 this.parseArguments(args);
 351
 352                 // Launch application
 353                 ApplicationManager.getManager(this).start();
 354
 355                 // Good bye, but this should not be reached ...
 356                 this.getLogger().warn("Unusual exit reached."); //NOI18N
 357                 try {
 358                         this.doShutdown();
 359                 } catch (final SQLException | IOException ex) {
 360                         this.abortProgramWithException(ex);
 361                 }
 362         }
 363
 364         /**
 365          * Main method (entry point)
 366          *
 367          * @param args the command line arguments
 368          */
 369         public static void main (String[] args) {
 370                 try {
 371                         // Start application
 372                         new AddressbookApplication().start(args);
 373                 } catch (final IOException ex) {
 374                         // Get instance
 375                         BaseFrameworkSystem.getInstance().getLogger().catching(ex);
 376                         System.exit(1);
 377                 }
 378         }
 379
 380         /**
 381          * Getter for printable application name
 382          *
 383          * @return A printable name
 384          */
 385         public static String printableTitle () {
 386                 return MessageFormat.format("{0} v{1}", APP_TITLE, APP_VERSION); //NOI18N
 387         }
 388 }