feat(openID): first stable version

SOPE/GDLContentStore/GCSFolderManager.h

@@ -31,7 +31,7 @@
 */
 
 @class NSString, NSArray, NSURL, NSDictionary, NSException;
-@class GCSChannelManager, GCSAlarmsFolder, GCSAdminFolder, GCSFolder, GCSFolderType, GCSSessionsFolder;
+@class GCSChannelManager, GCSAlarmsFolder, GCSAdminFolder, GCSFolder, GCSFolderType, GCSSessionsFolder, GCSOpenIdFolder;
 
 @interface GCSFolderManager : NSObject
 {
@@ -92,6 +92,9 @@
 /* admin */
 - (GCSAdminFolder *)adminFolder;
 
+/* openid */
+- (GCSOpenIdFolder *) openIdFolder;
+
 /* folder types */
 
 - (GCSFolderType *)folderTypeWithName:(NSString *)_name;

SOPE/GDLContentStore/GCSFolderManager.m

@@ -38,6 +38,7 @@
 #import "EOAdaptorChannel+GCS.h"
 #import "GCSAlarmsFolder.h"
 #import "GCSAdminFolder.h"
+#import "GCSOpenIdFolder.h"
 #import "GCSFolder.h"
 #import "GCSFolderType.h"
 #import "GCSSessionsFolder.h"
@@ -504,6 +505,12 @@ static BOOL       _singleStoreMode           = NO;
   return [GCSAdminFolder adminFolderWithFolderManager: self];
 }
 
+/* openId */
+- (GCSOpenIdFolder *) openIdFolder
+{
+  return [GCSOpenIdFolder openIdFolderWithFolderManager: self];
+}
+
 - (NSString *)generateSQLWhereForInternalNames:(NSArray *)_names
 				    exactMatch:(BOOL)_beExact orDirectSubfolderMatch:(BOOL)_directSubs
 {

SOPE/GDLContentStore/GCSOpenIdFolder.h

@@ -0,0 +1,57 @@
+/* GCSAdminFolder.h - this file is part of $PROJECT_NAME_HERE$
+ *
+ * Copyright (C) 2023 Alinto
+ *
+ * This file is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2, or (at your option)
+ * any later version.
+ *
+ * This file is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; see the file COPYING.  If not, write to
+ * the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+ * Boston, MA 02111-1307, USA.
+ */
+
+#ifndef GCSOPENIDFOLDER_H
+#define GCSOPENIDOLDER_H
+
+
+@class NSCalendarDate;
+@class NSException;
+@class NSNumber;
+@class NSString;
+
+@class GCSFolderManager;
+
+@interface GCSOpenIdFolder : NSObject
+{
+  GCSFolderManager *folderManager;
+}
+
++ (id)openIdFolderWithFolderManager:(GCSFolderManager *)newFolderManager;
+
+- (void) setFolderManager: (GCSFolderManager *) newFolderManager;
+
+/* operations */
+
+- (void) createFolderIfNotExists;
+- (BOOL) canConnectStore;
+
+- (NSString *) getRefreshToken: (NSString *) _user_session useOldSession: (BOOL) use_old_session;
+- (NSString *) getNewToken: (NSString *) _old_session;
+- (NSException *) writeOpenIdSession: (NSString *) _user_session
+                  withOldSession: (NSString *) _old_session
+                  withRefreshToken: (NSString *) _refresh_token
+                  withExpire: (NSNumber *) _expire
+                  withRefreshExpire: (NSNumber *) _refresh_expire;
+- (NSException *) deleteOpenIdSessionFor: (NSString *) _user_session;
+
+@end
+
+#endif /* GCSALARMSFOLDER_H */

SOPE/GDLContentStore/GCSOpenIdFolder.m

@@ -0,0 +1,363 @@
+/* GCSAdminFolder.m - this file is part of SOGo
+ *
+ * Copyright (C) 2023 Alinto
+ *
+ * This file is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2, or (at your option)
+ * any later version.
+ *
+ * This file is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; see the file COPYING.  If not, write to
+ * the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+ * Boston, MA 02111-1307, USA.
+ */
+
+
+#import <NGExtensions/NSObject+Logs.h>
+#import <NGExtensions/NSNull+misc.h>
+
+#import <GDLAccess/EOAdaptorContext.h>
+#import <GDLAccess/EOAttribute.h>
+#import <GDLAccess/EOEntity.h>
+#import <GDLAccess/EOSQLQualifier.h>
+
+#import "EOQualifier+GCS.h"
+#import "GCSChannelManager.h"
+#import "GCSFolderManager.h"
+#import "GCSSpecialQueries.h"
+#import "NSURL+GCS.h"
+
+#import "GCSOpenIdFolder.h"
+
+static NSString *openIdFolderURLString = nil;
+
+#warning GCSOpenIdFolder should share a common ancestor with GCSFolder
+
+@implementation GCSOpenIdFolder
+
++ (void) initialize
+{
+  NSUserDefaults *ud;
+
+  if (!openIdFolderURLString)
+  {
+    ud = [NSUserDefaults standardUserDefaults];
+    ASSIGN (openIdFolderURLString, [ud stringForKey: @"OCSOpenIdURL"]);
+  }
+}
+  
++ (id) openIdFolderWithFolderManager: (GCSFolderManager *) newFolderManager
+{
+  GCSOpenIdFolder *newFolder;
+
+  if (openIdFolderURLString)
+    {
+      newFolder = [self new];
+      [newFolder autorelease];
+      [newFolder setFolderManager: newFolderManager];
+    }
+  else
+    {
+      [self errorWithFormat: @"'OCSOpenIdURL' is not set"];
+      newFolder = nil;
+    }
+
+  return newFolder;
+}
+
+- (void) setFolderManager: (GCSFolderManager *) newFolderManager
+{
+  ASSIGN (folderManager, newFolderManager);
+}
+
+/* accessors */
+
+- (NSURL *) _location
+{
+  NSURL *location;
+
+  if (openIdFolderURLString)
+    location = [NSURL URLWithString: openIdFolderURLString];
+  else
+    {
+      [self warnWithFormat: @"'OCSOpenIdURL' is not set"];
+      location = nil;
+    }
+
+  return location;
+}
+
+- (GCSChannelManager *) _channelManager
+{
+  return [folderManager channelManager];
+}
+
+- (NSString *) _storeTableName
+{
+  return [[self _location] gcsTableName];
+}
+
+- (EOEntity *) _storeTableEntityForChannel: (EOAdaptorChannel *) tc
+{
+  static EOEntity *entity = nil;
+  EOAttribute *attribute;
+  NSString *tableName;
+  NSString *columns[] = {@"c_user_session", @"c_old_session", @"c_session_started", @"c_refresh_token", @"c_access_token_expires_in", @"c_refresh_token_expires_in", nil };
+  NSString **column;
+  NSMutableArray *keys;
+  NSDictionary *types;
+  
+  if (!entity)
+    {
+      entity = [EOEntity new];
+      tableName = [self _storeTableName];
+      [entity setName: tableName];
+      [entity setExternalName: tableName];
+
+      types = [[tc specialQueries] openIdAttributeTypes];
+
+      column = columns;
+      while (*column)
+        {
+          attribute = [EOAttribute new];
+          [attribute setName: *column];
+          [attribute setColumnName: *column];
+          [attribute setExternalType: [types objectForKey: *column]];
+          [entity addAttribute: attribute];
+          [attribute release];
+          column++;
+        }
+
+      keys = [NSMutableArray arrayWithCapacity: 1];
+      [keys addObject: [entity attributeNamed: @"c_user_session"]];
+      [entity setPrimaryKeyAttributes: keys];
+
+      keys = [NSMutableArray arrayWithCapacity: 5];
+      [keys addObject: [entity attributeNamed: @"c_old_session"]];
+      [keys addObject: [entity attributeNamed: @"c_session_started"]];
+      [keys addObject: [entity attributeNamed: @"c_refresh_token"]];
+      [keys addObject: [entity attributeNamed: @"c_access_token_expires_in"]];
+      [keys addObject: [entity attributeNamed: @"c_refresh_token_expires_in"]];
+      [entity setClassProperties: keys];
+      [entity setAttributesUsedForLocking: [NSArray array]];
+    }
+
+  return entity;
+}
+
+/* connection */
+
+- (EOAdaptorChannel *) _acquireStoreChannel
+{
+  return [[self _channelManager] acquireOpenChannelForURL: [self _location]];
+}
+
+- (void) _releaseChannel: (EOAdaptorChannel *) _channel
+{
+  [[self _channelManager] releaseChannel:_channel  immediately: YES];
+}
+
+- (BOOL) canConnectStore
+{
+  return [[self _channelManager] canConnect:[self _location]];
+}
+
+- (void) createFolderIfNotExists
+{
+  EOAdaptorChannel *tc;
+  NSString *sql, *tableName;
+  GCSSpecialQueries *queries;
+
+  tc = [self _acquireStoreChannel];
+  tableName = [self _storeTableName];
+
+  queries = [tc specialQueries];
+
+  sql = [NSString stringWithFormat: @"SELECT 1 FROM %@ WHERE 1 = 2", tableName];
+  if ([tc evaluateExpressionX: sql])
+  {
+    sql = [queries createOpenIdFolderWithName: tableName];
+    if (![tc evaluateExpressionX: sql])
+      [self logWithFormat: @"openid folder table '%@' successfully created!", tableName];
+  }
+  else
+    [tc cancelFetch];
+
+  [self _releaseChannel: tc];
+}
+
+/* operations */
+
+/* table has the following fields:
+    c_user_session              varchar(255)  NOT NULL,
+    c_session_started           int(11)       NOT NULL,
+    c_refresh_token             varchar(4096) DEFAULT '',
+    c_access_token_expires_in    int(11)       NOT NULL,
+    c_refresh_token_expires_in  int(11)       DEFAULT NULL,
+*/
+
+- (NSDictionary *) recordForSession: (NSString *) _user_session useOldSession: (BOOL) use_old_session
+{
+  EOAdaptorChannel *tc;
+  EOAdaptorContext *context;
+  NSException *error;
+  NSArray *attrs;
+  NSDictionary *record;
+  EOEntity *entity;
+  EOSQLQualifier *qualifier;
+
+  record = nil;
+
+  tc = [self _acquireStoreChannel];
+  if (tc)
+  {
+    context   = [tc adaptorContext];
+    entity    = [self _storeTableEntityForChannel: tc];
+    if(!use_old_session)
+      qualifier = [[EOSQLQualifier alloc] initWithEntity: entity
+                                         qualifierFormat: @"c_user_session='%@'", _user_session];
+    else
+      qualifier = [[EOSQLQualifier alloc] initWithEntity: entity
+                                         qualifierFormat: @"c_old_session='%@'", _user_session];
+    [qualifier autorelease];
+
+    [context beginTransaction];
+    error = [tc selectAttributesX: [entity attributesUsedForFetch]
+              describedByQualifier: qualifier
+                        fetchOrder: nil
+                              lock: NO];
+    if (error)
+      [self errorWithFormat:@"%s: cannot execute fetch: %@", __PRETTY_FUNCTION__, error];
+    else
+    {
+      attrs = [tc describeResults: NO];
+      record = [tc fetchAttributes: attrs withZone: NULL];
+      [tc cancelFetch];
+    }
+    [context rollbackTransaction];
+    [self _releaseChannel: tc];
+  }
+
+  return record;
+}
+
+- (NSString *) getRefreshToken: (NSString *) _user_session
+{
+  NSDictionary *r;
+
+  r = [self recordForSession: _user_session useOldSession: NO];
+  if (r && [r objectForKey:@"c_refresh_token"])
+    return [r objectForKey:@"c_refresh_token"];
+
+  return nil;
+}
+
+- (NSString *) getNewToken: (NSString *) _old_session
+{
+  NSDictionary *r;
+  r = [self recordForSession: _old_session useOldSession: YES];
+  if (r && [r objectForKey:@"c_user_session"])
+    return [r objectForKey:@"c_user_session"];
+
+  return nil;
+}
+
+
+- (NSException *) writeOpenIdSession: (NSString *) _user_session
+                  withOldSession: (NSString *) _old_session
+                  withRefreshToken: (NSString *) _refresh_token
+                  withExpire: (NSNumber *) _expire
+                  withRefreshExpire: (NSNumber *) _refresh_expire
+{
+  NSDictionary *record, *newRecord;
+  NSException *error;
+  NSCalendarDate *nowDate;
+  int now, nowExpire, nowRefreshExpire;
+  EOAdaptorChannel *tc;
+  EOAdaptorContext *context;
+  EOEntity *entity;
+  EOSQLQualifier *qualifier;
+
+  error = nil;
+  tc = [self _acquireStoreChannel];
+  if (tc)
+  {
+    context = [tc adaptorContext];
+
+    nowDate = [NSCalendarDate date];
+    now = (nowDate ? (int)[nowDate timeIntervalSince1970] : 0);
+    nowExpire = now + [_expire intValue];
+    if(_refresh_expire)
+      nowRefreshExpire = now + [_refresh_expire intValue];
+    else
+      nowRefreshExpire = -1;
+    if(!_old_session)
+      _old_session = @"";
+
+    newRecord = [NSDictionary dictionaryWithObjectsAndKeys: _user_session, @"c_user_session",
+                      _old_session, @"c_old_session",
+                      [NSNumber numberWithInt:now], @"c_session_started",
+                      _refresh_token, @"c_refresh_token",
+                      [NSNumber numberWithInt:nowExpire] , @"c_access_token_expires_in",
+                      [NSNumber numberWithInt:nowRefreshExpire] , @"c_refresh_token_expires_in",
+                      nil];
+    record = [self recordForSession: _user_session useOldSession: NO];
+    entity = [self _storeTableEntityForChannel: tc];
+    [context beginTransaction];
+    if (!record)
+    {
+      //If the session already exist no need to update it as it is unique
+      error = [tc insertRowX: newRecord forEntity: entity];
+    }
+      
+    if (error)
+    {
+      [context rollbackTransaction];
+      [self errorWithFormat:@"%s: cannot write record: %@",  __PRETTY_FUNCTION__, error];
+    }
+    else
+      [context commitTransaction];
+    [self _releaseChannel: tc];
+  }
+  return error;
+}
+
+- (NSException *) deleteOpenIdSessionFor: (NSString *) _user_session
+{
+  EOAdaptorChannel *tc;
+  EOAdaptorContext *context;
+  EOEntity *entity;
+  EOSQLQualifier *qualifier;
+  NSException *error;
+
+  error = nil;
+  tc = [self _acquireStoreChannel];
+  if (tc)
+  {
+    context = [tc adaptorContext];
+    entity = [self _storeTableEntityForChannel: tc];
+    qualifier = [[EOSQLQualifier alloc] initWithEntity: entity
+                                        qualifierFormat: @"c_user_session='%@'",_user_session];
+    [qualifier autorelease];
+    [context beginTransaction];
+    error = [tc deleteRowsDescribedByQualifierX: qualifier];
+    if (error)
+    {
+      [context rollbackTransaction];
+      [self errorWithFormat:@"%s: cannot delete record: %@", __PRETTY_FUNCTION__, error];
+    }
+    else
+      [context commitTransaction];
+    [self _releaseChannel: tc];
+  }
+  
+  return error;
+}
+
+@end

SOPE/GDLContentStore/GCSSpecialQueries.h

@@ -42,6 +42,9 @@
 - (NSString *)createAdminFolderWithName:(NSString *)tableName;
 - (NSDictionary *)adminAttributeTypes;
 
+- (NSString *)createOpenIdFolderWithName:(NSString *)tableName;
+- (NSDictionary *)openIdAttributeTypes;
+
 - (NSString *) updateCPathInFolderInfo:(NSString *)tableName
 withCPath2:(NSString *)c_path2;
 

SOPE/GDLContentStore/GCSSpecialQueries.m

@@ -95,6 +95,21 @@
   return nil;
 }
 
+- (NSString *) createOpenIdFolderWithName: (NSString *) tableName
+{
+  [self subclassResponsibility: _cmd];
+
+  return nil;
+}
+
+- (NSDictionary *) openIdAttributeTypes
+{
+  [self subclassResponsibility: _cmd];
+
+  return nil;
+}
+
+
 - (NSString *) createFolderTableWithName: (NSString *) tableName
 {
   [self subclassResponsibility: _cmd];
@@ -195,6 +210,38 @@
   return types;
 }
 
+- (NSString *) createOpenIdFolderWithName: (NSString *) tableName
+{
+  static NSString *sqlFolderFormat
+    = (@"CREATE TABLE %@ (" 
+       @" c_user_session VARCHAR(4096) NOT NULL,"
+       @" c_old_session VARCHAR(4096) NULL,"
+       @" c_session_started INT4 NOT NULL,"
+       @" c_refresh_token VARCHAR(4096) NULL,"
+       @" c_access_token_expires_in INT4 NOT NULL,"
+       @" c_refresh_token_expires_in INT4 NULL)");
+
+  return [NSString stringWithFormat: sqlFolderFormat, tableName];
+}
+
+- (NSDictionary *) openIdAttributeTypes
+{
+  static NSMutableDictionary *types = nil;
+
+  if (!types)
+    {
+      types = [NSMutableDictionary new];
+      [types setObject: @"varchar" forKey: @"c_user_session"];
+      [types setObject: @"varchar" forKey: @"c_old_session"];
+      [types setObject: @"int" forKey: @"c_session_started"];
+      [types setObject: @"varchar" forKey: @"c_refresh_token"];
+      [types setObject: @"int" forKey: @"c_access_token_expires_in"];
+      [types setObject: @"int" forKey: @"c_refresh_token_expires_in"];
+    }
+
+  return types;
+}
+
 - (NSString *) createFolderTableWithName: (NSString *) tableName
 {
   static NSString *sqlFolderFormat
@@ -324,6 +371,38 @@
   return types;
 }
 
+- (NSString *) createOpenIdFolderWithName: (NSString *) tableName
+{
+  static NSString *sqlFolderFormat
+    = (@"CREATE TABLE %@ (" 
+       @" c_user_session VARCHAR(4096) NOT NULL,"
+       @" c_old_session VARCHAR(4096) NULL,"
+       @" c_session_started INT4 NOT NULL,"
+       @" c_refresh_token VARCHAR(4096) NULL,"
+       @" c_access_token_expires_in INT4 NOT NULL,"
+       @" c_refresh_token_expires_in INT4 NULL)");
+
+  return [NSString stringWithFormat: sqlFolderFormat, tableName];
+}
+
+- (NSDictionary *) openIdAttributeTypes
+{
+  static NSMutableDictionary *types = nil;
+
+  if (!types)
+    {
+      types = [NSMutableDictionary new];
+      [types setObject: @"varchar" forKey: @"c_user_session"];
+      [types setObject: @"varchar" forKey: @"c_old_session"];
+      [types setObject: @"int" forKey: @"c_session_started"];
+      [types setObject: @"varchar" forKey: @"c_refresh_token"];
+      [types setObject: @"int" forKey: @"c_access_token_expires_in"];
+      [types setObject: @"int" forKey: @"c_refresh_token_expires_in"];
+    }
+
+  return types;
+}
+
 - (NSString *) createFolderTableWithName: (NSString *) tableName
 {
   static NSString *sqlFolderFormat
@@ -453,6 +532,38 @@
   return types;
 }
 
+- (NSString *) createOpenIdFolderWithName: (NSString *) tableName
+{
+  static NSString *sqlFolderFormat
+    = (@"CREATE TABLE %@ (" 
+       @" c_user_session VARCHAR2(4096) NOT NULL,"
+       @" c_old_session VARCHAR2(4096) NULL,"
+       @" c_session_started INTEGER NOT NULL,"
+       @" c_refresh_token VARCHAR2(4096) NULL,"
+       @" c_access_token_expires_in INTEGER NOT NULL,"
+       @" c_refresh_token_expires_in INTEGER NULL)");
+
+  return [NSString stringWithFormat: sqlFolderFormat, tableName];
+}
+
+- (NSDictionary *) openIdAttributeTypes
+{
+  static NSMutableDictionary *types = nil;
+
+  if (!types)
+    {
+      types = [NSMutableDictionary new];
+      [types setObject: @"varchar2" forKey: @"c_user_session"];
+      [types setObject: @"varchar2" forKey: @"c_old_session"];
+      [types setObject: @"integer" forKey: @"c_session_started"];
+      [types setObject: @"varchar2" forKey: @"c_refresh_token"];
+      [types setObject: @"integer" forKey: @"c_access_token_expires_in"];
+      [types setObject: @"integer" forKey: @"c_refresh_token_expires_in"];
+    }
+
+  return types;
+}
+
 - (NSString *) createFolderTableWithName: (NSString *) tableName
 {
   static NSString *sqlFolderFormat

SOPE/GDLContentStore/GNUmakefile

@@ -28,13 +28,14 @@ libGDLContentStore_HEADER_FILES +=		\
 	GCSAdminFolder.h			\
 	GCSContext.h				\
 	GCSFieldInfo.h				\
-	GCSFolder.h				\
+	GCSFolder.h				    \
 	GCSFolderManager.h			\
 	GCSFolderType.h				\
 	GCSChannelManager.h			\
+	GCSOpenIdFolder.h           \
 	GCSSessionsFolder.h			\
 	GCSSpecialQueries.h			\
-	GCSStringFormatter.h			\
+	GCSStringFormatter.h		\
 
 libGDLContentStore_OBJC_FILES +=		\
 	NSURL+GCS.m				\
@@ -45,13 +46,14 @@ libGDLContentStore_OBJC_FILES +=		\
 	GCSAdminFolder.m			\
 	GCSContext.m				\
 	GCSFieldInfo.m				\
-	GCSFolder.m				\
+	GCSFolder.m				    \
 	GCSFolderManager.m			\
 	GCSFolderType.m				\
 	GCSChannelManager.m			\
+	GCSOpenIdFolder.m           \
 	GCSSessionsFolder.m			\
 	GCSSpecialQueries.m			\
-	GCSStringFormatter.m			\
+	GCSStringFormatter.m	    \
 
 # framework support