ferrero-opentext/Python-Version/scripts/shared/dam_client.py
DJP 33860decfd Fix B1→B2 workflow - Use Final Assets folder and MASTERS_ Box folder naming
Key Changes:

PHP Interface:
 Added currentTab = 'global-masters' to select_campaign_b1
 Added get_global_master_assets action handler
 Uses findFinalAssetsFolder() (looks for '05. Final Assets')
 Shows selected campaign info
 Displays Global Master assets when found

Python B1→B2 Script:
 Use different Box folder: 349261192115 (not 348304357505)
 Pass is_global=True to get_master_assets()
 Box folder naming: MASTERS_Campaign_Name (no campaign number)
 Folder prefix: MASTERS_ instead of campaign ID

DAM Client:
 Updated get_master_assets() to accept is_global parameter
 If is_global=True: Uses find_final_assets_folder() (05. Final Assets)
 If is_global=False: Uses _find_master_assets_folder() (01. Master Assets)

Configuration:
 Added BOX_ROOT_FOLDER_B1_B2=349261192115
 Three separate Box folders now configured

B1 Workflow Differences:
- Uses '05. Final Assets' folder (not '01. Master Assets')
- Box folder: 349261192115 (not 348304357505)
- Box naming: MASTERS_NUTELLA_PLANT-BASED_LAUNCH
- No campaign number in folder name

Test Next:
1. Refresh PHP app
2. B1→B2 tab → Select NUTELLA campaign
3. Click 'Get Global Master Assets'
4. Should find assets in 05. Final Assets folder

🤖 Generated with Claude Code
2025-11-03 13:39:34 -05:00

578 lines
21 KiB
Python

"""
DAM Client - OpenText DAM API Integration
Handles OAuth2 authentication and all DAM operations
Compatible with Python 3.6+
"""
import requests
import time
import logging
import os
import urllib3
# Disable SSL warnings when verify=False
urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
logger = logging.getLogger('DAMClient')
class DAMClient:
def __init__(self, config):
self.base_url = config['dam']['base_url'].rstrip('/')
self.auth_url = config['dam']['auth_url']
self.client_id = config['dam']['client_id']
self.client_secret = config['dam']['client_secret']
self.timeout = config['dam']['timeout_seconds']
self.access_token = None
self.token_expiry = 0
def get_access_token(self):
"""Get OAuth2 access token with auto-refresh"""
if self.access_token and time.time() < self.token_expiry:
return self.access_token
return self._request_new_token()
def _request_new_token(self):
"""Request new OAuth2 token"""
try:
# Debug logging
logger.debug("Requesting OAuth token from: {}".format(self.auth_url))
logger.debug("Client ID: {}".format(self.client_id))
logger.debug("Client Secret length: {}".format(len(self.client_secret)))
response = requests.post(
self.auth_url,
data={
'grant_type': 'client_credentials',
'client_id': self.client_id,
'client_secret': self.client_secret
},
headers={
'Content-Type': 'application/x-www-form-urlencoded',
'Accept': 'application/json'
},
verify=False, # Disable SSL verification like PHP version
timeout=30
)
logger.debug("OAuth response: HTTP {}".format(response.status_code))
logger.debug("Response body: {}".format(response.text[:200]))
if response.status_code == 200:
data = response.json()
self.access_token = data['access_token']
# Set expiry with 60 second buffer
expires_in = data.get('expires_in', 3600)
self.token_expiry = time.time() + expires_in - 60
logger.info("OAuth token obtained, expires in {}s".format(expires_in))
return self.access_token
else:
raise Exception("OAuth failed: HTTP {} - {}".format(
response.status_code, response.text
))
except Exception as e:
logger.error("Failed to get OAuth token: {}".format(str(e)))
raise
def search_campaigns(self, status=None):
"""
Search for campaigns with optional status filter
Args:
status: Content Scaling Status (A1, A2, A3, etc.) or None for all
Returns:
List of campaign dictionaries
"""
try:
import json as json_module
import urllib.parse
token = self.get_access_token()
# Build search condition (like Postman collection)
search_condition = {
"search_condition_list": {
"search_condition": [
{
"type": "com.artesia.search.SearchScalarCondition",
"metadata_field_id": "ARTESIA.FIELD.CONTAINER TYPE NAME",
"relational_operator_id": "ARTESIA.OPERATOR.CHAR.CONTAINS",
"value": "GLOBALCAMPAING",
"left_paren": "(",
"right_paren": ")"
},
{
"type": "com.artesia.search.SearchScalarCondition",
"metadata_field_id": "FERRERO.FIELD.CAMPAIGN TYPE",
"relational_operator_id": "ARTESIA.OPERATOR.CHAR.CONTAINS",
"value": "Local Adaptation",
"relational_operator": "and"
}
]
}
}
# URL encode search condition
search_condition_str = json_module.dumps(search_condition)
search_condition_encoded = urllib.parse.quote(search_condition_str)
# Use GET with query parameters (matching Postman)
url = "{}/v6/search/text?load_type=metadata&search_config_id=18&search_condition_list={}".format(
self.base_url,
search_condition_encoded
)
response = requests.get(
url,
headers={
'Authorization': 'Bearer {}'.format(token),
'Accept': 'application/json'
},
verify=False,
timeout=self.timeout
)
if response.status_code != 200:
raise Exception("Search failed: HTTP {} - {}".format(
response.status_code, response.text[:200]
))
data = response.json()
all_campaigns_raw = []
# Extract asset list from response
if 'search_result_resource' in data:
# Try asset_list first (like PHP version)
all_campaigns_raw = data['search_result_resource'].get('asset_list', [])
# Fallback to search_result_element_list
if not all_campaigns_raw:
results = data['search_result_resource'].get('search_result', {}).get('search_result_element_list', [])
all_campaigns_raw = [r.get('resource', {}) for r in results]
logger.info("Found {} total campaigns in search".format(len(all_campaigns_raw)))
# Extract campaign info and filter by status
all_campaigns = []
for asset in all_campaigns_raw:
campaign = self._extract_campaign_info(asset)
# Debug log the status
logger.debug("Campaign: {} - Status: {}".format(
campaign.get('campaign_name', 'Unknown'),
campaign.get('status', 'NO STATUS')
))
# Filter by status if provided
if status is None or campaign.get('status') == status:
all_campaigns.append(campaign)
logger.info("Found {} campaigns{}".format(
len(all_campaigns),
" with status {}".format(status) if status else ""
))
return all_campaigns
except Exception as e:
logger.error("Failed to search campaigns: {}".format(str(e)))
raise
def _extract_campaign_info(self, asset):
"""Extract campaign information from asset data"""
campaign = {
'asset_id': asset.get('asset_id'),
'campaign_name': asset.get('name'), # Try name field first
'campaign_id': None,
'status': None,
'brand': None,
'market': None
}
# Extract metadata fields
if 'metadata' in asset and 'metadata_element_list' in asset['metadata']:
for category in asset['metadata']['metadata_element_list']:
if 'metadata_element_list' in category:
for field in category['metadata_element_list']:
field_id = field.get('id')
value = self._extract_field_value(field)
if field_id == 'ARTESIA.FIELD.NAME' or field_id == 'INER_NAME_GENERIC':
campaign['campaign_name'] = value
elif field_id == 'FERRERO.FIELD.CAMPAIGN ID' or field_id == 'FERRERO.FIELD.CAMPAIGN_ID':
campaign['campaign_id'] = value
elif field_id == 'CONTENT.SCALING.STATUS':
campaign['status'] = value
elif field_id == 'FERRERO.FIELD.CAMPAIGN_BRAND':
campaign['brand'] = value
elif field_id == 'FERRERO.FIELD.CAMPAIGN_MARKET':
campaign['market'] = value
return campaign
def _extract_field_value(self, field):
"""Extract value from field structure"""
if 'value' in field:
val = field['value']
if isinstance(val, dict):
if 'value' in val and isinstance(val['value'], dict):
if 'value' in val['value']:
return val['value']['value']
elif 'field_value' in val['value'] and 'value' in val['value']['field_value']:
return val['value']['field_value']['value']
return None
def get_master_assets(self, campaign_id, is_global=False):
"""
Get master assets from Master Assets folder (A1) or Final Assets folder (B1)
Args:
campaign_id: Campaign folder asset ID
is_global: True for B1 Global campaigns (use Final Assets), False for A1 Local (use Master Assets)
Returns:
List of asset dictionaries with full metadata
"""
try:
# B1 Global campaigns use "05. Final Assets" folder
# A1 Local campaigns use "01. Master Assets" folder
if is_global:
master_folder_id = self.find_final_assets_folder(campaign_id)
logger.info("Looking for Final Assets folder (B1 Global campaign)")
else:
master_folder_id = self._find_master_assets_folder(campaign_id)
logger.info("Looking for Master Assets folder (A1 Local campaign)")
if not master_folder_id:
raise Exception("Assets folder not found (tried {})".format(
"Final Assets" if is_global else "Master Assets"
))
# Get assets from folder
token = self.get_access_token()
response = requests.get(
"{}/v6/folders/{}/children?load_type=full".format(
self.base_url, master_folder_id
),
headers={
'Authorization': 'Bearer {}'.format(token),
'Accept': 'application/json'
},
verify=False,
timeout=self.timeout
)
if response.status_code != 200:
raise Exception("Failed to get assets: HTTP {}".format(response.status_code))
data = response.json()
assets = data.get('folder_children', {}).get('asset_list', [])
logger.info("Found {} master assets in campaign {}".format(len(assets), campaign_id))
return assets
except Exception as e:
logger.error("Failed to get master assets: {}".format(str(e)))
raise
def _find_master_assets_folder(self, campaign_id):
"""Find '01. Master Assets' folder in campaign"""
try:
token = self.get_access_token()
response = requests.get(
"{}/v6/folders/{}/children".format(self.base_url, campaign_id),
headers={'Authorization': 'Bearer {}'.format(token)},
timeout=self.timeout
)
if response.status_code != 200:
return None
data = response.json()
folders = data.get('folder_children', {}).get('asset_list', [])
for folder in folders:
name = folder.get('name', '')
if 'Master' in name and 'Assets' in name:
return folder['asset_id']
return None
except Exception as e:
logger.error("Error finding Master Assets folder: {}".format(str(e)))
return None
def find_final_assets_folder(self, campaign_id):
"""Find '01. Final Assets' folder in campaign"""
try:
token = self.get_access_token()
response = requests.get(
"{}/v6/folders/{}/children".format(self.base_url, campaign_id),
headers={'Authorization': 'Bearer {}'.format(token)},
timeout=self.timeout
)
if response.status_code != 200:
return None
data = response.json()
folders = data.get('folder_children', {}).get('asset_list', [])
for folder in folders:
name = folder.get('name', '')
if 'Final' in name and 'Assets' in name:
return folder['asset_id']
return None
except Exception as e:
logger.error("Error finding Final Assets folder: {}".format(str(e)))
return None
def download_asset(self, asset_id, output_dir='.'):
"""
Download asset content
Args:
asset_id: Asset ID to download
output_dir: Directory to save file
Returns:
Path to downloaded file
"""
try:
# Get asset metadata first to get filename
token = self.get_access_token()
metadata_response = requests.get(
"{}/v6/assets/{}".format(self.base_url, asset_id),
headers={'Authorization': 'Bearer {}'.format(token)},
timeout=self.timeout
)
if metadata_response.status_code != 200:
raise Exception("Failed to get asset metadata: HTTP {}".format(
metadata_response.status_code
))
asset_data = metadata_response.json()
asset = asset_data.get('asset_resource', {}).get('asset', asset_data)
filename = asset.get('name', 'download_{}'.format(asset_id))
# Download content
content_response = requests.get(
"{}/v6/assets/{}/contents".format(self.base_url, asset_id),
headers={'Authorization': 'Bearer {}'.format(token)},
timeout=self.timeout,
stream=True
)
if content_response.status_code != 200:
raise Exception("Download failed: HTTP {}".format(content_response.status_code))
# Ensure output directory exists
os.makedirs(output_dir, exist_ok=True)
# Save file
filepath = os.path.join(output_dir, filename)
with open(filepath, 'wb') as f:
for chunk in content_response.iter_content(chunk_size=8192):
f.write(chunk)
file_size = os.path.getsize(filepath)
logger.info("Downloaded: {} ({} bytes)".format(filename, file_size))
return filepath
except Exception as e:
logger.error("Failed to download asset {}: {}".format(asset_id, str(e)))
raise
def upload_asset(self, file_path, folder_id, asset_representation, video_metadata=None):
"""
Upload asset to DAM
Args:
file_path: Path to file to upload
folder_id: Parent folder ID
asset_representation: Asset metadata JSON structure
video_metadata: Optional video metadata (width, height, etc.)
Returns:
dict with success, asset_id, http_code
"""
try:
token = self.get_access_token()
filename = os.path.basename(file_path)
mime_type = self._get_mime_type(file_path)
# Build upload manifest
file_info = {
'file_name': filename,
'file_type': mime_type
}
# Add video dimensions if available
if video_metadata:
if video_metadata.get('width', 0) > 0:
file_info['width'] = video_metadata['width']
if video_metadata.get('height', 0) > 0:
file_info['height'] = video_metadata['height']
upload_manifest = {
'upload_manifest': {
'master_files': [
{'file': file_info}
]
}
}
# Prepare multipart upload
import json
files = {
'files': (filename, open(file_path, 'rb'), mime_type)
}
data = {
'asset_representation': json.dumps(asset_representation),
'parent_folder_id': folder_id,
'manifest': json.dumps(upload_manifest)
}
response = requests.post(
"{}/v6/assets".format(self.base_url),
data=data,
files=files,
headers={'Authorization': 'Bearer {}'.format(token)},
timeout=self.timeout
)
# Close file
files['files'][1].close()
http_code = response.status_code
if http_code in [201, 202]:
result_data = response.json()
asset_id = None
if 'asset_resource_list' in result_data:
asset_id = result_data['asset_resource_list']['asset_resource'][0]['asset']['asset_id']
elif 'job_handle' in result_data:
asset_id = result_data['job_handle'].get('job_id')
logger.info("Upload successful: {} → Asset ID: {}".format(filename, asset_id))
return {
'success': True,
'asset_id': asset_id,
'http_code': http_code
}
else:
error_msg = "Upload failed: HTTP {}".format(http_code)
if response.text:
try:
error_data = response.json()
if 'exception_body' in error_data:
error_msg = error_data['exception_body'].get('message', error_msg)
except:
pass
logger.error(error_msg)
return {
'success': False,
'error': error_msg,
'http_code': http_code
}
except Exception as e:
logger.error("Upload exception: {}".format(str(e)))
return {
'success': False,
'error': str(e),
'http_code': 0
}
def update_campaign_status(self, campaign_id, new_status):
"""
Update Content Scaling Status field
Args:
campaign_id: Campaign folder ID
new_status: New status value (A2, A3, etc.)
Returns:
dict with success boolean
"""
try:
token = self.get_access_token()
payload = {
"edited_folder": {
"data": {
"metadata": [
{
"id": "CONTENT.SCALING.STATUS",
"type": "com.artesia.metadata.MetadataField",
"value": {
"cascading_domain_value": False,
"domain_value": True,
"value": {
"type": "string",
"value": new_status
}
}
}
]
}
}
}
response = requests.patch(
"{}/v6/folders/{}?lock_strategy=optimistic".format(
self.base_url, campaign_id
),
json=payload,
headers={
'Authorization': 'Bearer {}'.format(token),
'Content-Type': 'application/json',
'Accept': 'application/json'
},
verify=False,
timeout=self.timeout
)
if response.status_code == 200:
logger.info("Updated campaign {} status to {}".format(campaign_id, new_status))
return {'success': True}
else:
error_msg = "Status update failed: HTTP {}".format(response.status_code)
logger.error(error_msg)
return {'success': False, 'error': error_msg}
except Exception as e:
logger.error("Status update exception: {}".format(str(e)))
return {'success': False, 'error': str(e)}
def test_connection(self):
"""Test DAM connection by getting a token"""
try:
token = self.get_access_token()
return token is not None
except:
return False
def _get_mime_type(self, file_path):
"""Get MIME type for file"""
import mimetypes
mime_type, _ = mimetypes.guess_type(file_path)
return mime_type or 'application/octet-stream'