SAP/abapGit
1
0
Fork 0
mirror of https://github.com/abapGit/abapGit.git synced 2025-05-02 04:36:49 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Merge pull request #1040 from christianguenter2/ENHS_HOOK_DEF

Browse Source 
ENHS: Add tooltype HOOK_DEF - Source Code Plug-In
This commit is contained in:
Lars Hvam 2017-11-05 09:47:29 +01:00 committed by GitHub
commit c75bf5121a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 292 additions and 94 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

364
src/zabapgit_object_enhs.prog.abap
View File

@ -2,6 +2,24 @@
*& Include ZABAPGIT_OBJECT_ENHS *& Include ZABAPGIT_OBJECT_ENHS
*&---------------------------------------------------------------------* *&---------------------------------------------------------------------*
* For complete list of tool_type - see ENHSPOTTOOLS table
INTERFACE lif_object_enhs.
METHODS:
deserialize
IMPORTING io_xml TYPE REF TO lcl_xml_input
iv_package TYPE devclass
ii_enh_spot_tool TYPE REF TO if_enh_spot_tool
RAISING zcx_abapgit_exception,
serialize
IMPORTING io_xml TYPE REF TO lcl_xml_output
ii_enh_spot_tool TYPE REF TO if_enh_spot_tool
RAISING zcx_abapgit_exception.
ENDINTERFACE. "lif_object_enho
*----------------------------------------------------------------------* *----------------------------------------------------------------------*
* CLASS lcl_object_enhs DEFINITION * CLASS lcl_object_enhs DEFINITION
*----------------------------------------------------------------------* *----------------------------------------------------------------------*
@ -11,8 +29,50 @@ CLASS lcl_object_enhs DEFINITION INHERITING FROM lcl_objects_super FINAL.
INTERFACES lif_object. INTERFACES lif_object.
ALIASES mo_files FOR lif_object~mo_files. ALIASES mo_files FOR lif_object~mo_files.
PRIVATE SECTION.
METHODS:
factory
IMPORTING
iv_tool TYPE enhtooltype
RETURNING
VALUE(ri_enho) TYPE REF TO lif_object_enhs
RAISING
zcx_abapgit_exception.
ENDCLASS. "lcl_object_enhs ENDCLASS. "lcl_object_enhs
*----------------------------------------------------------------------*
* CLASS lcl_object_enhs_badi_def DEFINITION
*----------------------------------------------------------------------*
CLASS lcl_object_enhs_badi_def DEFINITION.
PUBLIC SECTION.
INTERFACES: lif_object_enhs.
ENDCLASS.
*----------------------------------------------------------------------*
* CLASS lcl_object_enhs_hook_def DEFINITION
*----------------------------------------------------------------------*
CLASS lcl_object_enhs_hook_def DEFINITION.
PUBLIC SECTION.
INTERFACES: lif_object_enhs.
PRIVATE SECTION.
TYPES: BEGIN OF ty_hook_def,
pgmid TYPE pgmid,
obj_name TYPE trobj_name,
obj_type TYPE trobjtype,
main_type TYPE trobjtype,
main_name TYPE eu_aname,
program TYPE progname,
def_hooks TYPE enh_hook_def_ext_it,
END OF ty_hook_def.
ENDCLASS.
*----------------------------------------------------------------------* *----------------------------------------------------------------------*
* CLASS lcl_object_enhs IMPLEMENTATION * CLASS lcl_object_enhs IMPLEMENTATION
*----------------------------------------------------------------------* *----------------------------------------------------------------------*
@ -27,12 +87,12 @@ CLASS lcl_object_enhs IMPLEMENTATION.
DATA: lv_spot_name TYPE enhspotname, DATA: lv_spot_name TYPE enhspotname,
li_spot_ref TYPE REF TO if_enh_spot_tool. li_spot_ref TYPE REF TO if_enh_spot_tool.
lv_spot_name = ms_item-obj_name. lv_spot_name = ms_item-obj_name.
TRY. TRY.
li_spot_ref = cl_enh_factory=>get_enhancement_spot( lv_spot_name ). li_spot_ref = cl_enh_factory=>get_enhancement_spot( lv_spot_name ).
li_spot_ref->get_attributes( IMPORTING changedby = rv_user ). li_spot_ref->get_attributes( IMPORTING changedby = rv_user ).
CATCH cx_enh_root. CATCH cx_enh_root.
rv_user = c_user_unknown. rv_user = c_user_unknown.
ENDTRY. ENDTRY.
@ -41,38 +101,29 @@ CLASS lcl_object_enhs IMPLEMENTATION.
METHOD lif_object~deserialize. METHOD lif_object~deserialize.
DATA: lv_message TYPE string, DATA: lv_parent TYPE enhspotcompositename,
lv_parent TYPE enhspotcompositename,
lv_spot_name TYPE enhspotname, lv_spot_name TYPE enhspotname,
lv_enh_shtext TYPE string, lv_tool TYPE enhspottooltype,
ls_enh_badi TYPE enh_badi_data,
lt_enh_badi TYPE enh_badi_data_it,
lx_root TYPE REF TO cx_root,
lv_package LIKE iv_package, lv_package LIKE iv_package,
li_spot_ref TYPE REF TO if_enh_spot_tool, li_spot_ref TYPE REF TO if_enh_spot_tool,
lo_badidef_tool TYPE REF TO cl_enh_tool_badi_def. li_enhs TYPE REF TO lif_object_enhs,
lx_root TYPE REF TO cx_root.
lv_spot_name = ms_item-obj_name.
io_xml->read( EXPORTING iv_name = 'PARENT_COMP'
CHANGING cg_data = lv_parent ).
io_xml->read( EXPORTING iv_name = 'SHORTTEXT'
CHANGING cg_data = lv_enh_shtext ).
io_xml->read( EXPORTING iv_name = 'BADI_DATA'
CHANGING cg_data = lt_enh_badi ).
IF lif_object~exists( ) = abap_true. IF lif_object~exists( ) = abap_true.
lif_object~delete( ). lif_object~delete( ).
ENDIF. ENDIF.
io_xml->read( EXPORTING iv_name = 'TOOL'
CHANGING cg_data = lv_tool ).
lv_spot_name = ms_item-obj_name.
lv_package = iv_package. lv_package = iv_package.
TRY. TRY.
cl_enh_factory=>create_enhancement_spot( cl_enh_factory=>create_enhancement_spot(
EXPORTING EXPORTING
spot_name = lv_spot_name spot_name = lv_spot_name
tooltype = cl_enh_tool_badi_def=>tooltype tooltype = lv_tool
dark = abap_false dark = abap_false
compositename = lv_parent compositename = lv_parent
IMPORTING IMPORTING
@ -80,88 +131,53 @@ CLASS lcl_object_enhs IMPLEMENTATION.
CHANGING CHANGING
devclass = lv_package ). devclass = lv_package ).
lo_badidef_tool ?= li_spot_ref.
lo_badidef_tool->if_enh_object_docu~set_shorttext( lv_enh_shtext ).
LOOP AT lt_enh_badi INTO ls_enh_badi.
lo_badidef_tool->add_badi_def( ls_enh_badi ).
ENDLOOP.
lo_badidef_tool->if_enh_object~save( ).
lo_badidef_tool->if_enh_object~activate( ).
lo_badidef_tool->if_enh_object~unlock( ).
CATCH cx_enh_root INTO lx_root. CATCH cx_enh_root INTO lx_root.
lv_message = `Error occured while deserializing EHNS: ` zcx_abapgit_exception=>raise( 'Error from CL_ENH_FACTORY' ).
&& lx_root->get_text( ) ##NO_TEXT.
zcx_abapgit_exception=>raise( lv_message ).
ENDTRY. ENDTRY.
li_enhs = factory( lv_tool ).
li_enhs->deserialize( io_xml = io_xml
iv_package = iv_package
ii_enh_spot_tool = li_spot_ref ).
ENDMETHOD. "deserialize ENDMETHOD. "deserialize
METHOD lif_object~serialize. METHOD lif_object~serialize.
DATA: lv_spot_name TYPE enhspotname, DATA: lv_spot_name TYPE enhspotname,
lv_enh_shtext TYPE string,
lv_parent TYPE enhspotcompositename,
lt_enh_badi TYPE enh_badi_data_it,
lv_tool TYPE enhspottooltype,
lx_root TYPE REF TO cx_root,
li_spot_ref TYPE REF TO if_enh_spot_tool, li_spot_ref TYPE REF TO if_enh_spot_tool,
lo_badidef_tool TYPE REF TO cl_enh_tool_badi_def. li_enhs TYPE REF TO lif_object_enhs,
lx_root TYPE REF TO cx_root.
lv_spot_name = ms_item-obj_name. lv_spot_name = ms_item-obj_name.
TRY. TRY.
li_spot_ref = cl_enh_factory=>get_enhancement_spot( lv_spot_name ). li_spot_ref = cl_enh_factory=>get_enhancement_spot( lv_spot_name ).
lv_tool = li_spot_ref->get_tool( ).
lo_badidef_tool ?= li_spot_ref.
lv_enh_shtext = lo_badidef_tool->if_enh_object_docu~get_shorttext( ).
"get parent = composite enhs (ENHC)
lv_parent = cl_r3standard_persistence=>enh_find_parent_composite( lv_spot_name ).
"get subsequent BADI definitions
lt_enh_badi = lo_badidef_tool->get_badi_defs( ).
io_xml->add( ig_data = lv_tool
iv_name = 'TOOL' ).
io_xml->add( ig_data = lv_parent
iv_name = 'PARENT_COMP' ).
io_xml->add( ig_data = lv_enh_shtext
iv_name = 'SHORTTEXT' ).
io_xml->add( ig_data = lt_enh_badi
iv_name = 'BADI_DATA' ).
CATCH cx_enh_root INTO lx_root. CATCH cx_enh_root INTO lx_root.
zcx_abapgit_exception=>raise( `Error occured while serializing EHNS: ` zcx_abapgit_exception=>raise( 'Error from CL_ENH_FACTORY' ).
&& lx_root->get_text( ) ) ##NO_TEXT.
ENDTRY. ENDTRY.
li_enhs = factory( li_spot_ref->get_tool( ) ).
li_enhs->serialize( io_xml = io_xml
ii_enh_spot_tool = li_spot_ref ).
ENDMETHOD. "serialize ENDMETHOD. "serialize
METHOD lif_object~exists. METHOD lif_object~exists.
DATA: lv_spot_name TYPE enhspotname, DATA: lv_spot_name TYPE enhspotname,
lv_tool TYPE enhspottooltype,
li_spot_ref TYPE REF TO if_enh_spot_tool. li_spot_ref TYPE REF TO if_enh_spot_tool.
lv_spot_name = ms_item-obj_name. lv_spot_name = ms_item-obj_name.
TRY. TRY.
li_spot_ref = cl_enh_factory=>get_enhancement_spot( lv_spot_name ). li_spot_ref = cl_enh_factory=>get_enhancement_spot( lv_spot_name ).
lv_tool = li_spot_ref->get_tool( ).
CASE lv_tool.
WHEN cl_enh_tool_badi_def=>tooltype.
rv_bool = abap_true. rv_bool = abap_true.
WHEN OTHERS.
* todo: implement additional tool types
rv_bool = abap_false.
ENDCASE.
CATCH cx_enh_root. CATCH cx_enh_root.
rv_bool = abap_false. rv_bool = abap_false.
ENDTRY. ENDTRY.
@ -171,27 +187,22 @@ CLASS lcl_object_enhs IMPLEMENTATION.
METHOD lif_object~delete. METHOD lif_object~delete.
DATA: lv_spot_name TYPE enhspotname, DATA: lv_spot_name TYPE enhspotname,
lx_root TYPE REF TO cx_root, li_enh_object TYPE REF TO if_enh_object,
li_spot_ref TYPE REF TO if_enh_spot_tool, lx_root TYPE REF TO cx_root.
lo_badidef_tool TYPE REF TO cl_enh_tool_badi_def.
lv_spot_name = ms_item-obj_name. lv_spot_name = ms_item-obj_name.
TRY. TRY.
li_spot_ref = cl_enh_factory=>get_enhancement_spot( li_enh_object ?= cl_enh_factory=>get_enhancement_spot( spot_name = lv_spot_name
spot_name = lv_spot_name
lock = abap_true ). lock = abap_true ).
IF li_spot_ref IS BOUND. li_enh_object->delete( nevertheless_delete = abap_true
lo_badidef_tool ?= li_spot_ref.
lo_badidef_tool->if_enh_object~delete(
nevertheless_delete = abap_true
run_dark = abap_true ). run_dark = abap_true ).
ENDIF.
lo_badidef_tool->if_enh_object~unlock( ). li_enh_object->unlock( ).
CATCH cx_enh_root INTO lx_root. CATCH cx_enh_root INTO lx_root.
zcx_abapgit_exception=>raise( `Error occured while deleting EHNS: ` zcx_abapgit_exception=>raise( 'Error from CL_ENH_FACTORY' ).
&& lx_root->get_text( ) ) ##NO_TEXT.
ENDTRY. ENDTRY.
ENDMETHOD. "delete ENDMETHOD. "delete
@ -215,4 +226,191 @@ CLASS lcl_object_enhs IMPLEMENTATION.
CREATE OBJECT ro_comparison_result TYPE lcl_comparison_null. CREATE OBJECT ro_comparison_result TYPE lcl_comparison_null.
ENDMETHOD. ENDMETHOD.
METHOD factory.
CASE iv_tool.
WHEN cl_enh_tool_badi_def=>tooltype.
CREATE OBJECT ri_enho TYPE lcl_object_enhs_badi_def.
WHEN cl_enh_tool_hook_def=>tool_type.
CREATE OBJECT ri_enho TYPE lcl_object_enhs_hook_def.
WHEN OTHERS.
zcx_abapgit_exception=>raise( |ENHS: Unsupported tool { iv_tool }| ).
ENDCASE.
ENDMETHOD.
ENDCLASS. "lcl_object_enhs ENDCLASS. "lcl_object_enhs
*----------------------------------------------------------------------*
* CLASS lcl_object_enhs_badi_def IMPLEMENTATION
*----------------------------------------------------------------------*
CLASS lcl_object_enhs_badi_def IMPLEMENTATION.
METHOD lif_object_enhs~deserialize.
DATA: lv_parent TYPE enhspotcompositename,
lt_enh_badi TYPE enh_badi_data_it,
lo_badidef_tool TYPE REF TO cl_enh_tool_badi_def,
lv_enh_shorttext TYPE string,
lv_package LIKE iv_package,
li_enh_object TYPE REF TO if_enh_object,
li_enh_object_docu TYPE REF TO if_enh_object_docu,
lv_text TYPE string,
lx_error TYPE REF TO cx_enh_root.
FIELD-SYMBOLS: <ls_enh_badi> LIKE LINE OF lt_enh_badi.
io_xml->read( EXPORTING iv_name = 'PARENT_COMP'
CHANGING cg_data = lv_parent ).
io_xml->read( EXPORTING iv_name = 'BADI_DATA'
CHANGING cg_data = lt_enh_badi ).
io_xml->read( EXPORTING iv_name = 'SHORTTEXT'
CHANGING cg_data = lv_enh_shorttext ).
lv_package = iv_package.
li_enh_object ?= ii_enh_spot_tool.
li_enh_object_docu ?= ii_enh_spot_tool.
TRY.
li_enh_object_docu->set_shorttext( lv_enh_shorttext ).
lo_badidef_tool ?= ii_enh_spot_tool.
LOOP AT lt_enh_badi ASSIGNING <ls_enh_badi>.
lo_badidef_tool->add_badi_def( <ls_enh_badi> ).
ENDLOOP.
li_enh_object->save( ).
li_enh_object->activate( ).
li_enh_object->unlock( ).
CATCH cx_enh_root INTO lx_error.
lv_text = lx_error->get_text( ).
zcx_abapgit_exception=>raise( lv_text ).
ENDTRY.
ENDMETHOD.
METHOD lif_object_enhs~serialize.
DATA: lv_spot_name TYPE enhspotname,
lv_parent TYPE enhspotcompositename,
lt_enh_badi TYPE enh_badi_data_it,
lo_badidef_tool TYPE REF TO cl_enh_tool_badi_def,
lv_enh_shorttext TYPE string,
li_enh_object_docu TYPE REF TO if_enh_object_docu.
lo_badidef_tool ?= ii_enh_spot_tool.
li_enh_object_docu ?= ii_enh_spot_tool.
lv_enh_shorttext = li_enh_object_docu->get_shorttext( ).
"get parent = composite enhs (ENHC)
lv_parent = cl_r3standard_persistence=>enh_find_parent_composite( lv_spot_name ).
"get subsequent BADI definitions
lt_enh_badi = lo_badidef_tool->get_badi_defs( ).
io_xml->add( ig_data = ii_enh_spot_tool->get_tool( )
iv_name = 'TOOL' ).
io_xml->add( ig_data = lv_enh_shorttext
iv_name = 'SHORTTEXT' ).
io_xml->add( ig_data = lv_parent
iv_name = 'PARENT_COMP' ).
io_xml->add( ig_data = lt_enh_badi
iv_name = 'BADI_DATA' ).
ENDMETHOD.
ENDCLASS.
*----------------------------------------------------------------------*
* CLASS lcl_object_enhs_hook_def IMPLEMENTATION
*----------------------------------------------------------------------*
CLASS lcl_object_enhs_hook_def IMPLEMENTATION.
METHOD lif_object_enhs~deserialize.
DATA: lv_enh_shorttext TYPE string,
ls_enh_hook_definition TYPE enh_hook_def,
ls_hook_definition TYPE ty_hook_def,
li_enh_object TYPE REF TO if_enh_object,
li_enh_object_docu TYPE REF TO if_enh_object_docu,
lo_hookdef_tool TYPE REF TO cl_enh_tool_hook_def,
lx_error TYPE REF TO cx_enh_root,
lv_text TYPE string.
FIELD-SYMBOLS: <ls_hook_definition> TYPE enh_hook_def_ext.
io_xml->read( EXPORTING iv_name = 'SHORTTEXT'
CHANGING cg_data = lv_enh_shorttext ).
io_xml->read( EXPORTING iv_name = 'BADI_DATA'
CHANGING cg_data = ls_hook_definition ).
li_enh_object ?= ii_enh_spot_tool.
li_enh_object_docu ?= ii_enh_spot_tool.
TRY.
li_enh_object_docu->set_shorttext( lv_enh_shorttext ).
lo_hookdef_tool ?= ii_enh_spot_tool.
LOOP AT ls_hook_definition-def_hooks ASSIGNING <ls_hook_definition>.
MOVE-CORRESPONDING <ls_hook_definition> TO ls_enh_hook_definition.
lo_hookdef_tool->add_hook_def( ls_enh_hook_definition ).
ENDLOOP.
li_enh_object->save( ).
li_enh_object->activate( ).
li_enh_object->unlock( ).
CATCH cx_enh_root INTO lx_error.
lv_text = lx_error->get_text( ).
zcx_abapgit_exception=>raise( lv_text ).
ENDTRY.
ENDMETHOD.
METHOD lif_object_enhs~serialize.
DATA: lo_hookdef_tool TYPE REF TO cl_enh_tool_hook_def,
lv_enh_shorttext TYPE string,
li_enh_object_docu TYPE REF TO if_enh_object_docu,
lv_include_bound TYPE enhboolean,
ls_hook_definition TYPE ty_hook_def.
lo_hookdef_tool ?= ii_enh_spot_tool.
li_enh_object_docu ?= ii_enh_spot_tool.
lv_enh_shorttext = li_enh_object_docu->get_shorttext( ).
ls_hook_definition-def_hooks = lo_hookdef_tool->get_hook_defs( ).
lv_include_bound = lo_hookdef_tool->get_include_bound( ).
lo_hookdef_tool->get_original_object(
IMPORTING
pgmid = ls_hook_definition-pgmid
obj_name = ls_hook_definition-obj_name
obj_type = ls_hook_definition-obj_type
main_type = ls_hook_definition-main_type
main_name = ls_hook_definition-main_name
program = ls_hook_definition-program ).
io_xml->add( ig_data = ii_enh_spot_tool->get_tool( )
iv_name = 'TOOL' ).
io_xml->add( ig_data = lv_enh_shorttext
iv_name = 'SHORTTEXT' ).
io_xml->add( ig_data = ls_hook_definition
iv_name = 'BADI_DATA' ).
ENDMETHOD.
ENDCLASS.