Updated build number

GLPIAPI.py

@@ -3,7 +3,7 @@ import json
 from datetime import datetime
 
 class GLPIAPI:
-    def __init__(self, Server, AppToken, UserToken, UserAgent="GLPI API"):
+    def __init__(self, Server, AppToken, UserToken, UserAgent="GLPI API", Profile=None):
         self.Server = Server
         self.AppToken = AppToken
         self.UserToken = UserToken
@@ -11,7 +11,16 @@ class GLPIAPI:
         self.SessionToken = None
         self.StatusCode = None
         self.Headers = None
+        self.ActiveProfile = None
+        self.ActiveEntity = None
+        self.RecurseEntity = True
         self.InitConnection()
+        if(Profile == None):
+            self.ActiveProfile = self.GetActiveProfile()[0]
+        else:
+            self.ActiveProfile = Profile
+            profileId = self.GetItems('Profile', 'Profile.name', Profile)[1]['2']
+            self.SetActiveProfile(profileId)
 
     def InitConnection(self):
         initURI = '/apirest.php/initSession/'
@@ -32,6 +41,20 @@ class GLPIAPI:
                 "Session-Token": self.SessionToken,
                 "App-Token": self.AppToken
             }
+            if(self.GetActiveProfile()[0] != self.ActiveProfile and self.ActiveProfile != None):
+                profile = [p for p in self.GetUserProfiles() if p["name"] == self.ActiveProfile]
+                if(profile != []):
+                    self.SetActiveProfile(profile[0]["id"])
+                else:
+                    raise Exception(f"{self.ActiveProfile} is not in user profiles")
+            
+            ActiveEntities = self.GetActiveEntity()
+            if((ActiveEntities[0] != self.ActiveEntity or ActiveEntities[1] != self.RecurseEntity) and self.ActiveEntity != None):
+                entity = [e for e in self.GetUserEntities() if e["id"] == self.ActiveEntity]
+                if(entity != []):
+                    self.SetActiveEntity(entity[0]["id"], self.RecurseEntity)
+                else:
+                    raise Exception(f"{self.ActiveEntity} is not in user entities")
         else:
             raise Exception(f"{result.status_code} - {result.json()[0]}")
             
@@ -40,9 +63,84 @@ class GLPIAPI:
         result = requests.get(sessionUri, headers=self.Headers)
         if(result.status_code != 200 and result.json()[0] == 'ERROR_SESSION_TOKEN_INVALID'):
             self.InitConnection()
-        return
+        return result.status_code
     
-    def GetComputers(self, deviceName=None, serialNumber=None, user=None, imei=None, airwatchDevice=None):
+    def GetUserProfiles(self):
+        self.CheckConnection()
+        uri = f"{self.Server}/apirest.php/getMyProfiles"
+        req = requests.get(uri, headers=self.Headers)
+        if(req.status_code == 200):
+            return req.json()['myprofiles']
+        else:
+            return req.status_code
+
+    def GetActiveProfile(self):
+        self.CheckConnection()
+        uri = f"{self.Server}/apirest.php/getActiveProfile"
+        req = requests.get(uri, headers=self.Headers)
+        if(req.status_code == 200):
+            return (req.json()['active_profile']['name'],req.json()['active_profile']['id'])
+        else:
+            return req.status_code
+
+    def SetActiveProfile(self, profile):
+        self.CheckConnection()
+        if(type(profile) == str):
+            profileFound = [p for p in self.GetUserProfiles() if p["name"] == profile]
+            if(profileFound != []):
+                profileId = profileFound[0]["id"]
+        else:
+            profileId = profile
+        body = {
+            "profiles_id" : profileId
+        }
+        
+        uri = f"{self.Server}/apirest.php/changeActiveProfile"
+        req = requests.post(uri, headers=self.Headers, json=body)
+        if(req.status_code == 200):
+            self.ActiveProfile = self.GetActiveProfile()[0]
+        return req.status_code
+        
+    def GetUserEntities(self):
+        self.CheckConnection()
+        uri = f"{self.Server}/apirest.php/getMyEntities"
+        req = requests.get(uri, headers=self.Headers)
+        if(req.status_code == 200):
+            return req.json()["myentities"]
+        else:
+            return req.status_code
+    
+    def GetActiveEntity(self):
+        self.CheckConnection()
+        uri = f"{self.Server}/apirest.php/getActiveEntities"
+        req = requests.get(uri, headers=self.Headers)
+        if(req.status_code == 200):
+            return (req.json()['active_entity']['id'], req.json()['active_entity']['active_entity_recursive'], req.json()['active_entity']['active_entities'])
+        else:
+            return req.status_code
+    
+    def SetActiveEntity(self, entity, recurse=True):
+        self.CheckConnection()
+        if(type(entity) == str):
+            entityFound = [e for e in self.GetUserEntities() if e["name"] == entity]
+            if(entityFound != []):
+                entityId = entityFound[0]["id"]
+        else:
+            entityId = entity
+        body = {
+            "entities_id" : entityId,
+            "is_recursive" : recurse
+        }
+        
+        uri = f"{self.Server}/apirest.php/changeActiveEntities"
+        req = requests.post(uri, headers=self.Headers, json=body)
+        if(req.status_code == 200):
+            ActiveEntities = self.GetActiveEntity()
+            self.ActiveEntity = ActiveEntities[0]
+            self.RecurseEntity = ActiveEntities[1]
+        return req.status_code
+    
+    def GetComputers(self, deviceName=None, serialNumber=None, user=None, imei=None, airwatchDevice=None, fieldsToDisplay=[], trashbin=0):
         '''
         Search for computer items in GLPI based on one of the possibles parameters :
           - deviceName : name of the item
@@ -50,7 +148,10 @@ class GLPIAPI:
           - user : user of the item
           - imei : custom field using field plugin (only for internal use)
           - airwatchDevice : an airwatchDevice object from airwatchAPI module
-        If no parameters are set, it will search for all items
+        If no parameters are set, it will search for all items.
+        
+        fieldsToDisplay: set fields to forcefully add to the results of the search (must be a list [])
+        trashbin: set if the search is in the trashbin or not (0 not in the trash or 1 in the trash)
         
         Return a tuple with item id, item data and item count.
         '''
@@ -58,43 +159,47 @@ class GLPIAPI:
         searchAll = False
         if(deviceName != None):
             # Recherche en fonction du nom de l'appareil
-            search_parameter = f'is_deleted=0&criteria[0][field]=1&withindexes=true&criteria[0][searchtype]=contains&criteria[0][value]=^{deviceName}$'
+            search_parameter = f'is_deleted={trashbin}&criteria[0][field]=1&withindexes=true&criteria[0][searchtype]=contains&criteria[0][value]=^{deviceName}$'
         elif(user != None):
             # Recherche en fonction de l'utilisateur de l'appareil
-            search_parameter = f'is_deleted=0&criteria[0][field]=70&withindexes=true&criteria[0][searchtype]=contains&criteria[0][value]=^{user}$'    
+            search_parameter = f'is_deleted={trashbin}&criteria[0][field]=70&withindexes=true&criteria[0][searchtype]=contains&criteria[0][value]=^{user}$'    
         elif(airwatchDevice != None):
             if(airwatchDevice.Imei != ''):
                 # Recherche des appareils en fonction du numéro de série ou de l'imei
                 # l'imei pouvant être dans le champ numéro de série ou les champs imei custom (plugin field)
-                search_parameter = f'is_deleted=0&criteria[0][field]=5&withindexes=true&criteria[0][searchtype]=contains&criteria[0][value]=^{airwatchDevice.SerialNumber}$'\
+                search_parameter = f'is_deleted={trashbin}&criteria[0][field]=5&withindexes=true&criteria[0][searchtype]=contains&criteria[0][value]=^{airwatchDevice.SerialNumber}$'\
                 f'&criteria[1][link]=OR&criteria[1][field]=5&criteria[1][searchtype]=contains&criteria[1][value]=^{airwatchDevice.Imei}$'\
                 f'&criteria[2][link]=OR&criteria[2][field]=76667&criteria[2][searchtype]=contains&criteria[2][value]=^{airwatchDevice.Imei}$'\
                 f'&criteria[3][link]=OR&criteria[3][field]=76670&criteria[3][searchtype]=contains&criteria[3][value]=^{airwatchDevice.Imei}$'
             else:
                 # Recherche des appareils en fonction du numéro de série seulement
-                search_parameter = f'is_deleted=0&criteria[0][field]=5&withindexes=true&criteria[0][searchtype]=contains&criteria[0][value]=^{airwatchDevice.SerialNumber}$'
+                search_parameter = f'is_deleted={trashbin}&criteria[0][field]=5&withindexes=true&criteria[0][searchtype]=contains&criteria[0][value]=^{airwatchDevice.SerialNumber}$'
 
         elif(imei != None):
                 # Recherche des appareils en fonction du numéro de série ou de l'imei
                 # l'imei pouvant être dans le champ numéro de série ou les champs imei custom (plugin field)
-                search_parameter = f'is_deleted=0&criteria[0][field]=5&withindexes=true&criteria[0][searchtype]=contains&criteria[0][value]=^{serialNumber}$'\
+                search_parameter = f'is_deleted={trashbin}&criteria[0][field]=5&withindexes=true&criteria[0][searchtype]=contains&criteria[0][value]=^{serialNumber}$'\
                 f'&criteria[1][link]=OR&criteria[1][field]=5&criteria[1][searchtype]=contains&criteria[1][value]=^{imei}$'\
                 f'&criteria[2][link]=OR&criteria[2][field]=76667&criteria[2][searchtype]=contains&criteria[2][value]=^{imei}$'\
                 f'&criteria[3][link]=OR&criteria[3][field]=76670&criteria[3][searchtype]=contains&criteria[3][value]=^{imei}$'
                 
         elif(serialNumber != None):
             # Recherche des appareils en fonction du numéro de série seulement
-            search_parameter = f'is_deleted=0&criteria[0][field]=5&withindexes=true&criteria[0][searchtype]=contains&criteria[0][value]=^{serialNumber}$'
+            search_parameter = f'is_deleted={trashbin}&criteria[0][field]=5&withindexes=true&criteria[0][searchtype]=contains&criteria[0][value]=^{serialNumber}$'
             
         else:
             # Recherche de l'ensemble des appareils si rien n'est renseigné
             searchAll = True
             
-            search_parameter = f'is_deleted=0&criteria[0][link]=AND&criteria[0][field]=view&criteria[0][searchtype]=contains&criteria[0][value]='
         if(searchAll):
-            searchUri = f"{self.Server}/apirest.php/search/Computer/?range=0-9999999&is_deleted=0"
+            searchUri = f"{self.Server}/apirest.php/search/Computer/?range=0-9999999&is_deleted={trashbin}"
         else:
             searchUri = f"{self.Server}/apirest.php/search/Computer?{search_parameter}"
+            
+        if(fieldsToDisplay != []):
+            for i in range(len(fieldsToDisplay)):
+                searchUri += f"&forcedisplay[{i}]={fieldsToDisplay[i]}"
+            
         search = requests.get(searchUri, headers=self.Headers)
         if(search.status_code == 200):
             search = search.json()
@@ -115,7 +220,7 @@ class GLPIAPI:
                 
         return None, search, 0
     
-    def GetItems(self, itemType, fieldName=None, fieldValue=None):
+    def GetItems(self, itemType, fieldName=None, fieldValue=None, fieldsToDisplay=[], trashbin=0):
         '''
         Search for items of a specific item type in GLPI. A filter can be set using fieldName and fieldValue :
         fieldName: must be the name of the field as visible in GLPI
@@ -130,15 +235,22 @@ class GLPIAPI:
         if(fieldName != None and fieldValue != None):
             fieldId = list(self.GetSearchOptions(itemType, fieldName))[0]
             # Recherche en fonction de l'utilisateur de l'appareil
-            search_parameter = f'is_deleted=0&criteria[0][field]={fieldId}&withindexes=true&criteria[0][searchtype]=contains&criteria[0][value]=^{fieldValue}$'
+            search_parameter = f'is_deleted={trashbin}&criteria[0][field]={fieldId}&withindexes=true&criteria[0][searchtype]=contains&criteria[0][value]=^{fieldValue}$'
         else:
             searchAll = True
         
         if(searchAll):
-            searchUri = f"{self.Server}/apirest.php/search/{itemType}/?range=0-9999999&is_deleted=0"
+            searchUri = f"{self.Server}/apirest.php/search/{itemType}/?range=0-9999999&is_deleted={trashbin}"
         else:
             searchUri = f"{self.Server}/apirest.php/search/{itemType}?{search_parameter}"
         
+        idFieldNumber = list(self.GetSearchOptions(itemType, f'{itemType}.id'))[0]
+        searchUri += f"&forcedisplay[0]={idFieldNumber}"
+
+        if(fieldsToDisplay != []):
+            for i in range(1, len(fieldsToDisplay)+1):
+                searchUri += f"&forcedisplay[{i}]={fieldsToDisplay[i-1]}"
+                
         search = requests.get(searchUri, headers=self.Headers)
         
         if(search.status_code == 200):
@@ -150,7 +262,6 @@ class GLPIAPI:
                 return itemID, data, search["totalcount"]
             elif(search["totalcount"] > 1):
                 if(searchAll):
-                    idFieldNumber = list(self.GetSearchOptions(itemType, 'id'))[0]
                     itemID = [i[idFieldNumber] for i in search["data"]]
                 else:
                     itemID = list(search["data"].keys())
@@ -160,7 +271,7 @@ class GLPIAPI:
                 
         return None, search, 0
     
-    def GetUsers(self, username=None, email=None):
+    def GetUsers(self, username=None, email=None, fieldsToDisplay=[], trashbin=0):
         '''
         Search for users in GLPI based on one of the possibles parameters :
           - username : username of the glpi user
@@ -172,13 +283,12 @@ class GLPIAPI:
         fieldName = None
         fieldValue = None
         if(username != None):
-            fieldName = 'login'
+            fieldName = 'User.name'
             fieldValue = username
         elif(email != None):
-            fieldName = 'Emails'
+            fieldName = 'User.UserEmail.email'
             fieldValue = email
-        
-        return self.GetItems("User", fieldName, fieldValue)
+        return self.GetItems("User", fieldName, fieldValue, fieldsToDisplay, trashbin)
         
     def GetSearchOptions(self, itemType, fieldName=None):
         self.CheckConnection()
@@ -188,7 +298,7 @@ class GLPIAPI:
             searchOptions = searchOptions.json()
             if(fieldName != None):
                 for k,v in searchOptions.items():
-                    if(v['name'].lower() == fieldName.lower()):
+                    if('uid' in v.keys() and v['uid'].lower() == fieldName.lower()):
                         return {k : searchOptions[k]}
             return searchOptions
         return searchOptions.status_code

build/pyproject.toml

@@ -7,7 +7,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "GLPIAPI"
-version = "1.0.4"
+version = "1.0.6"
 description = "A module python to make it easier to use GLPI API"
 readme = "README.md"
 dependencies = [