489 lines
22 KiB
Python
489 lines
22 KiB
Python
"""Connector for SharePoint operations using Microsoft Graph API."""
|
|
|
|
import logging
|
|
import aiohttp
|
|
import asyncio
|
|
from typing import Dict, Any, List, Optional
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
class SharepointService:
|
|
"""SharePoint connector using Microsoft Graph API for reliable authentication."""
|
|
|
|
def __init__(self, serviceCenter=None):
|
|
"""Initialize SharePoint service without access token.
|
|
|
|
Args:
|
|
serviceCenter: Service center instance for accessing other services
|
|
|
|
Use setAccessTokenFromConnection() method to configure the access token before making API calls.
|
|
"""
|
|
self.services = serviceCenter
|
|
self.accessToken = None
|
|
self.baseUrl = "https://graph.microsoft.com/v1.0"
|
|
|
|
def setAccessTokenFromConnection(self, userConnection) -> bool:
|
|
"""Set access token from UserConnection.
|
|
|
|
Args:
|
|
userConnection: UserConnection object containing token information
|
|
|
|
Returns:
|
|
bool: True if token was set successfully, False otherwise
|
|
"""
|
|
try:
|
|
if not userConnection:
|
|
logger.error("UserConnection is required to set access token")
|
|
return False
|
|
|
|
# Get a fresh token for this specific connection
|
|
from modules.security.tokenManager import TokenManager
|
|
token = TokenManager().getFreshToken(userConnection.id)
|
|
if not token:
|
|
logger.error(f"No token found for connection {userConnection.id}")
|
|
return False
|
|
|
|
self.accessToken = token.tokenAccess
|
|
logger.info(f"Access token set for connection {userConnection.id}")
|
|
return True
|
|
|
|
except Exception as e:
|
|
logger.error(f"Error setting access token: {str(e)}")
|
|
return False
|
|
|
|
async def _makeGraphApiCall(self, endpoint: str, method: str = "GET", data: bytes = None) -> Dict[str, Any]:
|
|
"""Make a Microsoft Graph API call with proper error handling."""
|
|
try:
|
|
if self.accessToken is None:
|
|
logger.error("Access token is not set. Please call setAccessTokenFromConnection() before using the SharePoint service.")
|
|
return {"error": "Access token is not set. Please call setAccessTokenFromConnection() before using the SharePoint service."}
|
|
|
|
headers = {
|
|
"Authorization": f"Bearer {self.accessToken}",
|
|
"Content-Type": "application/json" if data and method != "PUT" else "application/octet-stream" if data else "application/json"
|
|
}
|
|
|
|
# Remove leading slash from endpoint to avoid double slash
|
|
cleanEndpoint = endpoint.lstrip('/')
|
|
url = f"{self.baseUrl}/{cleanEndpoint}"
|
|
logger.debug(f"Making Graph API call: {method} {url}")
|
|
|
|
timeout = aiohttp.ClientTimeout(total=30)
|
|
|
|
async with aiohttp.ClientSession(timeout=timeout) as session:
|
|
if method == "GET":
|
|
async with session.get(url, headers=headers) as response:
|
|
if response.status == 200:
|
|
return await response.json()
|
|
else:
|
|
error_text = await response.text()
|
|
logger.error(f"Graph API call failed: {response.status} - {error_text}")
|
|
return {"error": f"API call failed: {response.status} - {error_text}"}
|
|
|
|
elif method == "PUT":
|
|
async with session.put(url, headers=headers, data=data) as response:
|
|
if response.status in [200, 201]:
|
|
return await response.json()
|
|
else:
|
|
error_text = await response.text()
|
|
logger.error(f"Graph API call failed: {response.status} - {error_text}")
|
|
return {"error": f"API call failed: {response.status} - {error_text}"}
|
|
|
|
elif method == "POST":
|
|
async with session.post(url, headers=headers, data=data) as response:
|
|
if response.status in [200, 201]:
|
|
return await response.json()
|
|
else:
|
|
error_text = await response.text()
|
|
logger.error(f"Graph API call failed: {response.status} - {error_text}")
|
|
return {"error": f"API call failed: {response.status} - {error_text}"}
|
|
|
|
except asyncio.TimeoutError:
|
|
logger.error(f"Graph API call timed out after 30 seconds: {endpoint}")
|
|
return {"error": f"API call timed out after 30 seconds: {endpoint}"}
|
|
except Exception as e:
|
|
logger.error(f"Error making Graph API call: {str(e)}")
|
|
return {"error": f"Error making Graph API call: {str(e)}"}
|
|
|
|
async def discoverSites(self) -> List[Dict[str, Any]]:
|
|
"""Discover all SharePoint sites accessible to the user."""
|
|
try:
|
|
result = await self._makeGraphApiCall("sites?search=*")
|
|
|
|
if "error" in result:
|
|
logger.error(f"Error discovering SharePoint sites: {result['error']}")
|
|
return []
|
|
|
|
sites = result.get("value", [])
|
|
logger.info(f"Discovered {len(sites)} SharePoint sites")
|
|
|
|
processedSites = []
|
|
for site in sites:
|
|
siteInfo = {
|
|
"id": site.get("id"),
|
|
"displayName": site.get("displayName"),
|
|
"name": site.get("name"),
|
|
"webUrl": site.get("webUrl"),
|
|
"description": site.get("description"),
|
|
"createdDateTime": site.get("createdDateTime"),
|
|
"lastModifiedDateTime": site.get("lastModifiedDateTime")
|
|
}
|
|
processedSites.append(siteInfo)
|
|
logger.debug(f"Site: {siteInfo['displayName']} - {siteInfo['webUrl']}")
|
|
|
|
return processedSites
|
|
|
|
except Exception as e:
|
|
logger.error(f"Error discovering SharePoint sites: {str(e)}")
|
|
return []
|
|
|
|
async def findSiteByName(self, siteName: str) -> Optional[Dict[str, Any]]:
|
|
"""Find a specific SharePoint site by name using direct Graph API call."""
|
|
try:
|
|
# Try to get the site directly by name using Graph API
|
|
endpoint = f"sites/{siteName}"
|
|
result = await self._makeGraphApiCall(endpoint)
|
|
|
|
if result and "error" not in result:
|
|
siteInfo = {
|
|
"id": result.get("id"),
|
|
"displayName": result.get("displayName"),
|
|
"name": result.get("name"),
|
|
"webUrl": result.get("webUrl"),
|
|
"description": result.get("description"),
|
|
"createdDateTime": result.get("createdDateTime"),
|
|
"lastModifiedDateTime": result.get("lastModifiedDateTime")
|
|
}
|
|
logger.info(f"Found site directly: {siteInfo['displayName']} - {siteInfo['webUrl']}")
|
|
return siteInfo
|
|
|
|
except Exception as e:
|
|
logger.debug(f"Direct site lookup failed for '{siteName}': {str(e)}")
|
|
|
|
# Fallback to discovery if direct lookup fails
|
|
logger.info(f"Direct lookup failed, trying discovery for site: {siteName}")
|
|
sites = await self.discoverSites()
|
|
if not sites:
|
|
logger.warning("No sites discovered")
|
|
return None
|
|
|
|
logger.info(f"Discovered {len(sites)} SharePoint sites:")
|
|
for site in sites:
|
|
logger.info(f" - {site.get('displayName', 'Unknown')} (ID: {site.get('id', 'Unknown')})")
|
|
|
|
# Try exact match first
|
|
for site in sites:
|
|
if site.get("displayName", "").strip().lower() == siteName.strip().lower():
|
|
logger.info(f"Found exact match: {site.get('displayName')}")
|
|
return site
|
|
|
|
# Try partial match
|
|
for site in sites:
|
|
if siteName.lower() in site.get("displayName", "").lower():
|
|
logger.info(f"Found partial match: {site.get('displayName')}")
|
|
return site
|
|
|
|
logger.warning(f"No site found matching: {siteName}")
|
|
return None
|
|
|
|
async def findSiteByWebUrl(self, webUrl: str) -> Optional[Dict[str, Any]]:
|
|
"""Find a SharePoint site using its web URL (useful for guest sites)."""
|
|
try:
|
|
# Use the web URL format: sites/{hostname}:/sites/{site-path}
|
|
# Extract hostname and site path from the web URL
|
|
if not webUrl.startswith("https://"):
|
|
webUrl = f"https://{webUrl}"
|
|
|
|
# Parse the URL to extract hostname and site path
|
|
from urllib.parse import urlparse
|
|
parsed = urlparse(webUrl)
|
|
hostname = parsed.hostname
|
|
pathParts = parsed.path.strip('/').split('/')
|
|
|
|
if len(pathParts) >= 2 and pathParts[0] == 'sites':
|
|
sitePath = '/'.join(pathParts[1:]) # Everything after 'sites/'
|
|
else:
|
|
logger.error(f"Invalid SharePoint URL format: {webUrl}")
|
|
return None
|
|
|
|
endpoint = f"sites/{hostname}:/sites/{sitePath}"
|
|
logger.debug(f"Trying web URL format: {endpoint}")
|
|
|
|
result = await self._makeGraphApiCall(endpoint)
|
|
|
|
if result and "error" not in result:
|
|
siteInfo = {
|
|
"id": result.get("id"),
|
|
"displayName": result.get("displayName"),
|
|
"name": result.get("name"),
|
|
"webUrl": result.get("webUrl"),
|
|
"description": result.get("description"),
|
|
"createdDateTime": result.get("createdDateTime"),
|
|
"lastModifiedDateTime": result.get("lastModifiedDateTime")
|
|
}
|
|
logger.info(f"Found site by web URL: {siteInfo['displayName']} - {siteInfo['webUrl']} (ID: {siteInfo['id']})")
|
|
return siteInfo
|
|
else:
|
|
logger.warning(f"Site not found using web URL: {webUrl}")
|
|
return None
|
|
|
|
except Exception as e:
|
|
logger.error(f"Error finding site by web URL: {str(e)}")
|
|
return None
|
|
|
|
async def findSiteByUrl(self, hostname: str, sitePath: str) -> Optional[Dict[str, Any]]:
|
|
"""Find a SharePoint site using the site URL format."""
|
|
try:
|
|
# For guest sites, try different URL formats
|
|
urlFormats = [
|
|
f"sites/{hostname}:/sites/{sitePath}", # Standard format
|
|
f"sites/{hostname}:/sites/{sitePath}/", # With trailing slash
|
|
f"sites/{hostname}:/sites/{sitePath.lower()}", # Lowercase
|
|
f"sites/{hostname}:/sites/{sitePath.lower()}/", # Lowercase with slash
|
|
]
|
|
|
|
for endpoint in urlFormats:
|
|
logger.debug(f"Trying URL format: {endpoint}")
|
|
result = await self._makeGraphApiCall(endpoint)
|
|
|
|
if result and "error" not in result:
|
|
siteInfo = {
|
|
"id": result.get("id"),
|
|
"displayName": result.get("displayName"),
|
|
"name": result.get("name"),
|
|
"webUrl": result.get("webUrl"),
|
|
"description": result.get("description"),
|
|
"createdDateTime": result.get("createdDateTime"),
|
|
"lastModifiedDateTime": result.get("lastModifiedDateTime")
|
|
}
|
|
logger.info(f"Found site by URL: {siteInfo['displayName']} - {siteInfo['webUrl']} (ID: {siteInfo['id']})")
|
|
return siteInfo
|
|
else:
|
|
logger.debug(f"URL format failed: {endpoint} - {result.get('error', 'Unknown error')}")
|
|
|
|
logger.warning(f"Site not found using any URL format for: {hostname}:/sites/{sitePath}")
|
|
return None
|
|
|
|
except Exception as e:
|
|
logger.error(f"Error finding site by URL: {str(e)}")
|
|
return None
|
|
|
|
async def getFolderByPath(self, siteId: str, folderPath: str) -> Optional[Dict[str, Any]]:
|
|
"""Get folder information by path within a site."""
|
|
try:
|
|
# Clean the path
|
|
cleanPath = folderPath.lstrip('/')
|
|
endpoint = f"sites/{siteId}/drive/root:/{cleanPath}"
|
|
|
|
result = await self._makeGraphApiCall(endpoint)
|
|
|
|
if "error" in result:
|
|
logger.warning(f"Folder not found at path {folderPath}: {result['error']}")
|
|
return None
|
|
|
|
return result
|
|
|
|
except Exception as e:
|
|
logger.error(f"Error getting folder by path: {str(e)}")
|
|
return None
|
|
|
|
async def uploadFile(self, siteId: str, folderPath: str, fileName: str, content: bytes) -> Dict[str, Any]:
|
|
"""Upload a file to SharePoint."""
|
|
try:
|
|
# Clean the path
|
|
cleanPath = folderPath.lstrip('/')
|
|
uploadPath = f"{cleanPath.rstrip('/')}/{fileName}"
|
|
endpoint = f"sites/{siteId}/drive/root:/{uploadPath}:/content"
|
|
|
|
logger.info(f"Uploading file to: {endpoint}")
|
|
|
|
result = await self._makeGraphApiCall(endpoint, method="PUT", data=content)
|
|
|
|
if "error" in result:
|
|
logger.error(f"Upload failed: {result['error']}")
|
|
return result
|
|
|
|
logger.info(f"File uploaded successfully: {fileName}")
|
|
return result
|
|
|
|
except Exception as e:
|
|
logger.error(f"Error uploading file: {str(e)}")
|
|
return {"error": f"Error uploading file: {str(e)}"}
|
|
|
|
async def downloadFile(self, siteId: str, fileId: str) -> Optional[bytes]:
|
|
"""Download a file from SharePoint."""
|
|
try:
|
|
if self.accessToken is None:
|
|
logger.error("Access token is not set. Please call setAccessTokenFromConnection() before using the SharePoint service.")
|
|
return None
|
|
|
|
endpoint = f"sites/{siteId}/drive/items/{fileId}/content"
|
|
|
|
headers = {"Authorization": f"Bearer {self.accessToken}"}
|
|
timeout = aiohttp.ClientTimeout(total=30)
|
|
|
|
async with aiohttp.ClientSession(timeout=timeout) as session:
|
|
async with session.get(f"{self.baseUrl}/{endpoint}", headers=headers) as response:
|
|
if response.status == 200:
|
|
return await response.read()
|
|
else:
|
|
logger.error(f"Download failed: {response.status}")
|
|
return None
|
|
|
|
except Exception as e:
|
|
logger.error(f"Error downloading file: {str(e)}")
|
|
return None
|
|
|
|
async def listFolderContents(self, siteId: str, folderPath: str = "") -> List[Dict[str, Any]]:
|
|
"""List contents of a folder."""
|
|
try:
|
|
if not folderPath or folderPath == "/":
|
|
endpoint = f"sites/{siteId}/drive/root/children"
|
|
else:
|
|
cleanPath = folderPath.lstrip('/')
|
|
endpoint = f"sites/{siteId}/drive/root:/{cleanPath}:/children"
|
|
|
|
result = await self._makeGraphApiCall(endpoint)
|
|
|
|
if "error" in result:
|
|
logger.warning(f"Failed to list folder contents: {result['error']}")
|
|
return None
|
|
|
|
items = result.get("value", [])
|
|
processedItems = []
|
|
|
|
for item in items:
|
|
# Determine if it's a folder or file
|
|
isFolder = 'folder' in item
|
|
|
|
itemInfo = {
|
|
"id": item.get("id"),
|
|
"name": item.get("name"),
|
|
"type": "folder" if isFolder else "file",
|
|
"size": item.get("size", 0),
|
|
"createdDateTime": item.get("createdDateTime"),
|
|
"lastModifiedDateTime": item.get("lastModifiedDateTime"),
|
|
"webUrl": item.get("webUrl")
|
|
}
|
|
|
|
if "file" in item:
|
|
itemInfo["mimeType"] = item["file"].get("mimeType")
|
|
itemInfo["downloadUrl"] = item.get("@microsoft.graph.downloadUrl")
|
|
|
|
if "folder" in item:
|
|
itemInfo["childCount"] = item["folder"].get("childCount", 0)
|
|
|
|
processedItems.append(itemInfo)
|
|
|
|
return processedItems
|
|
|
|
except Exception as e:
|
|
logger.error(f"Error listing folder contents: {str(e)}")
|
|
return []
|
|
|
|
async def searchFiles(self, siteId: str, query: str) -> List[Dict[str, Any]]:
|
|
"""Search for files in a site."""
|
|
try:
|
|
searchQuery = query.replace("'", "''") # Escape single quotes for OData
|
|
endpoint = f"sites/{siteId}/drive/root/search(q='{searchQuery}')"
|
|
|
|
result = await self._makeGraphApiCall(endpoint)
|
|
|
|
if "error" in result:
|
|
logger.warning(f"Search failed: {result['error']}")
|
|
return []
|
|
|
|
items = result.get("value", [])
|
|
processedItems = []
|
|
|
|
for item in items:
|
|
isFolder = 'folder' in item
|
|
|
|
itemInfo = {
|
|
"id": item.get("id"),
|
|
"name": item.get("name"),
|
|
"type": "folder" if isFolder else "file",
|
|
"size": item.get("size", 0),
|
|
"createdDateTime": item.get("createdDateTime"),
|
|
"lastModifiedDateTime": item.get("lastModifiedDateTime"),
|
|
"webUrl": item.get("webUrl"),
|
|
"parentPath": item.get("parentReference", {}).get("path", "")
|
|
}
|
|
|
|
if "file" in item:
|
|
itemInfo["mimeType"] = item["file"].get("mimeType")
|
|
itemInfo["downloadUrl"] = item.get("@microsoft.graph.downloadUrl")
|
|
|
|
processedItems.append(itemInfo)
|
|
|
|
return processedItems
|
|
|
|
except Exception as e:
|
|
logger.error(f"Error searching files: {str(e)}")
|
|
return []
|
|
|
|
async def copyFileAsync(self, siteId: str, sourceFolder: str, sourceFile: str, destFolder: str, destFile: str) -> None:
|
|
"""Copy a file from source to destination folder (like original synchronizer)."""
|
|
try:
|
|
# First, download the source file
|
|
sourcePath = f"{sourceFolder}/{sourceFile}"
|
|
fileContent = await self.downloadFileByPath(siteId=siteId, filePath=sourcePath)
|
|
|
|
if not fileContent:
|
|
raise Exception(f"Failed to download source file: {sourcePath}")
|
|
|
|
# Upload to destination
|
|
await self.uploadFile(
|
|
siteId=siteId,
|
|
folderPath=destFolder,
|
|
fileName=destFile,
|
|
content=fileContent
|
|
)
|
|
|
|
logger.info(f"File copied: {sourceFile} -> {destFile}")
|
|
|
|
except Exception as e:
|
|
# Provide more specific error information
|
|
errorMsg = str(e)
|
|
if "itemNotFound" in errorMsg or "404" in errorMsg:
|
|
raise Exception(f"Source file not found (404): {sourcePath} - {errorMsg}")
|
|
else:
|
|
raise Exception(f"Error copying file: {errorMsg}")
|
|
|
|
async def downloadFileByPath(self, siteId: str, filePath: str) -> Optional[bytes]:
|
|
"""Download a file by its path within a site."""
|
|
try:
|
|
if self.accessToken is None:
|
|
logger.error("Access token is not set. Please call setAccessTokenFromConnection() before using the SharePoint service.")
|
|
return None
|
|
|
|
# Clean the path
|
|
cleanPath = filePath.strip('/')
|
|
endpoint = f"sites/{siteId}/drive/root:/{cleanPath}:/content"
|
|
|
|
# Use direct HTTP call for file downloads (binary content)
|
|
headers = {
|
|
"Authorization": f"Bearer {self.accessToken}",
|
|
}
|
|
|
|
# Remove leading slash from endpoint to avoid double slash
|
|
cleanEndpoint = endpoint.lstrip('/')
|
|
url = f"{self.baseUrl}/{cleanEndpoint}"
|
|
logger.debug(f"Downloading file: GET {url}")
|
|
|
|
timeout = aiohttp.ClientTimeout(total=30)
|
|
|
|
async with aiohttp.ClientSession(timeout=timeout) as session:
|
|
async with session.get(url, headers=headers) as response:
|
|
if response.status == 200:
|
|
return await response.read()
|
|
else:
|
|
error_text = await response.text()
|
|
logger.error(f"File download failed: {response.status} - {error_text}")
|
|
return None
|
|
|
|
except Exception as e:
|
|
logger.error(f"Error downloading file by path: {str(e)}")
|
|
return None
|
|
|