'''
=======================================================================================================
gen_cmm_data1.py:

Usage:
   gen_cmm_data1 <temp_cmm_script_file_name>
   
   Examples:
      gen_cmm_data1 c:\\temp\\temp1.cmm

Description:
   This script generates a CMM script for consumption by Trace32. gen_cmm_data1.py and gen_cmm_data2.py work together.
   gen_cmm_data1.py should be called from a CMM script to generate a temporary CMM script that will define variables
   containing the root paths to each of the component builds, and, if defined in the contents.xml file, a list of flavors 
   for the builds.  gen_cmm_data2.py receives one of the flavors from gen_cmm_data1.py and returns a list of file paths 
   for that flavor.

 Copyright (c) 2011-2017 by Qualcomm Technologies, Incorporated. All Rights Reserved.
 QUALCOMM Proprietary/GTDR 
-----------------------------------------------------------------------------------------------
  $Header: //components/rel/build.glue/2.0/app/gen_cmm_data1.py#2 $
  $DateTime: 2018/02/23 22:19:32 $
===============================================================================================
'''

import sys
import os
import os.path
sys.path.append(os.path.abspath(os.path.join(__file__, '../../lib')))
import meta_log as lg

if len(sys.argv) == 2:
   temp_file = sys.argv[1]
else:
   print ("Error: Invalid number of parameters.")
   print (__doc__)
   sys.exit()

dst_path = os.path.dirname(temp_file)
if (dst_path != '' and  # '' implies current directory, and is allowed
    not os.path.isdir(dst_path)):
   print ("Can't find destination directory:"+ str(dst_path))
   print (__doc__)
   sys.exit(1)
logfile = os.path.join(dst_path, 'gen_cmm_data1')

lg = lg.Logger(logfile, save_old_log_file=False)

lg.log("Platform is:" + sys.platform)
lg.log("Python Version is:" + sys.version)
lg.log("Current directory is:" + os.getcwd())
lg.log("Args are:" + str(sys.argv))

flavors = ''
cmm_script_header = ''
cmm_tag_template = '''GLOBAL &%s
&%s="%s"
'''
cmm_script_trailer = '''ENDDO'''
exception = False
sys.path.append(os.path.dirname(__file__))
import meta_lib as ml

mi = ml.meta_info(logger=lg)

cmm_script = open(temp_file, 'w')

cmm_script.write(cmm_script_header)
lg.log("Processing meta info")

# Look for generic cmm_var attributes
var_values = mi.get_var_values('cmm_var')
for var in var_values:
   cmm_script.write(cmm_tag_template % (var, var, var_values[var]))

# Look for cmm_file_var attributes:
# file_vars = mi.get_file_var_values('cmm_file_var')
# for var in file_vars:
#   cmm_script.write(cmm_tag_template % (var, var, file_vars[var]))

flavors_list = mi.get_product_flavors()
for var in flavors_list:
   flavors += var + ';'
# flavors = flavors[:-1]

var_values = mi.get_var_values('cmm_pf_var')
if var_values:
   for var in var_values:
      cmm_script.write(cmm_tag_template % (var, var , flavors))
else:
   # Just hard-code the PRODUCT_FLAVORS variable for now.
   cmm_script.write(cmm_tag_template % ('PRODUCT_FLAVORS', 'PRODUCT_FLAVORS', ''))

# Look for special cmm_root_path_var attributes.  These require special
# processing to verify that it's actually pointing to a valid build.
for tag in mi.get_build_list():
   # Don't process the current build
   if tag != 'common':
      lg.log("   Processing " + tag)
      path, attrs = mi.get_build_path(tag, get_attrs=True)
      if attrs and 'cmm_root_path_var' in attrs:
         cmm_var_name = attrs['cmm_root_path_var']
         if path and cmm_var_name:
            image_dir = mi.get_image_dir(tag)
            image_path_dir = os.path.join(path, image_dir)
            if image_dir and os.path.isdir(image_path_dir):
               cmm_script.write(cmm_tag_template % (cmm_var_name, cmm_var_name, path))
            elif image_dir and (path != mi.get_build_path('common')):
               if not os.path.exists(os.path.join(dst_path, 'EXCEPTION.txt')):
                  exception_txt = os.path.join(dst_path, 'EXCEPTION.txt')
                  exception_FILE = open(exception_txt, 'w')
                  # Temporary hack until ravi kumar delivers a cmm script which removes the exception.txt if it already exists.
                  exception = True
                  exception_FILE.write("The following build paths are missing LOGIN rights or have been zipped : \n")
               exception_FILE.write(cmm_var_name + " : " + image_path_dir + "\n")
            else:
               cmm_script.write(cmm_tag_template % (cmm_var_name, cmm_var_name, ''))

     
# Write the trailer for the file
cmm_script.write(cmm_script_trailer)
cmm_script.close()

if os.path.exists(os.path.join(dst_path, 'EXCEPTION.txt')) and exception == True:
   exception_FILE.close()
else:
   # Create a file TEMP_SUCCESS.txt to indicate the successful completion of TEMP.cmm
   success_txt = os.path.join(dst_path, 'SUCCESS.txt')
   success_FILE = open(success_txt, 'w')
   success_FILE.close()