SAP/abapGit
1
0
Fork 0
mirror of https://github.com/abapGit/abapGit.git synced 2025-04-30 03:36:32 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
d79887c0a2
abapGit/src/ui/pages/zcl_abapgit_gui_page_patch.clas.abap
Christian Günter d79887c0a2
Some checks are pending
main-build / build-merged (push) Waiting to run
Details
main-build / auto-tag (push) Waiting to run
Details
main-build / auto-tag-artifact (push) Blocked by required conditions
Details
main-build / coverage (push) Waiting to run
Details
Repo Refactoring: Use interfaces instead of classes (#7189) 
Co-authored-by: Marc Bernard <59966492+mbtools@users.noreply.github.com>
Co-authored-by: Lars Hvam <larshp@hotmail.com>
2025-04-10 08:52:51 +02:00

712 lines
18 KiB
ABAP
Raw Blame History

CLASS zcl_abapgit_gui_page_patch DEFINITION
PUBLIC
INHERITING FROM zcl_abapgit_gui_page_diff_base
CREATE PUBLIC.
PUBLIC SECTION.
CLASS-METHODS create
IMPORTING
!iv_key TYPE zif_abapgit_persistence=>ty_repo-key
!is_file TYPE zif_abapgit_git_definitions=>ty_file OPTIONAL
!is_object TYPE zif_abapgit_definitions=>ty_item OPTIONAL
!it_files TYPE zif_abapgit_definitions=>ty_stage_tt OPTIONAL
RETURNING
VALUE(ri_page) TYPE REF TO zif_abapgit_gui_renderable
RAISING
zcx_abapgit_exception.
METHODS constructor
IMPORTING
!iv_key TYPE zif_abapgit_persistence=>ty_repo-key
!is_file TYPE zif_abapgit_git_definitions=>ty_file OPTIONAL
!is_object TYPE zif_abapgit_definitions=>ty_item OPTIONAL
!it_files TYPE zif_abapgit_definitions=>ty_stage_tt OPTIONAL
RAISING
zcx_abapgit_exception.
CLASS-METHODS get_patch_data
IMPORTING
!iv_patch TYPE string
EXPORTING
!ev_filename TYPE string
!ev_line_index TYPE string
RAISING
zcx_abapgit_exception.
METHODS:
zif_abapgit_gui_event_handler~on_event REDEFINITION,
zif_abapgit_gui_hotkeys~get_hotkey_actions REDEFINITION,
zif_abapgit_gui_renderable~render REDEFINITION.
PROTECTED SECTION.
METHODS:
add_menu_begin REDEFINITION,
add_menu_end REDEFINITION,
insert_nav REDEFINITION,
refresh REDEFINITION,
render_beacon_begin_of_row REDEFINITION,
render_diff_head_after_state REDEFINITION,
render_line_split_row REDEFINITION,
render_table_head_non_unified REDEFINITION.
PRIVATE SECTION.
TYPES ty_patch_action TYPE string .
CONSTANTS:
BEGIN OF c_patch_actions,
stage TYPE string VALUE 'patch_stage',
END OF c_patch_actions .
CONSTANTS:
BEGIN OF c_patch_action,
add TYPE ty_patch_action VALUE 'add',
remove TYPE ty_patch_action VALUE 'remove',
END OF c_patch_action .
DATA mo_stage TYPE REF TO zcl_abapgit_stage .
DATA mv_section_count TYPE i .
DATA mv_pushed TYPE abap_bool .
DATA mi_repo_online TYPE REF TO zif_abapgit_repo_online .
METHODS render_patch
IMPORTING
!ii_html TYPE REF TO zif_abapgit_html
!iv_filename TYPE string
!is_diff_line TYPE zif_abapgit_definitions=>ty_diff
!iv_index TYPE sy-tabix
RAISING
zcx_abapgit_exception .
METHODS render_patch_head
IMPORTING
!ii_html TYPE REF TO zif_abapgit_html
!is_diff TYPE ty_file_diff .
METHODS start_staging
IMPORTING
!ii_event TYPE REF TO zif_abapgit_gui_event
RAISING
zcx_abapgit_exception .
METHODS apply_patch_from_form_fields
IMPORTING
!ii_event TYPE REF TO zif_abapgit_gui_event
RAISING
zcx_abapgit_exception .
METHODS restore_patch_flags
IMPORTING
!it_diff_files_old TYPE ty_file_diffs
RAISING
zcx_abapgit_exception .
METHODS add_to_stage
RAISING
zcx_abapgit_exception .
METHODS apply_patch_all
IMPORTING
!iv_patch TYPE string
!iv_patch_flag TYPE abap_bool
RAISING
zcx_abapgit_exception .
METHODS are_all_lines_patched
IMPORTING
!it_diff TYPE zif_abapgit_definitions=>ty_diffs_tt
RETURNING
VALUE(rv_are_all_lines_patched) TYPE abap_bool .
METHODS apply_patch_for
IMPORTING
!iv_filename TYPE string
!iv_line_index TYPE string
!iv_patch_flag TYPE abap_bool
RAISING
zcx_abapgit_exception .
METHODS get_diff_object
IMPORTING
!iv_filename TYPE string
RETURNING
VALUE(ro_diff) TYPE REF TO zcl_abapgit_diff
RAISING
zcx_abapgit_exception .
METHODS get_diff_line
IMPORTING
!io_diff TYPE REF TO zcl_abapgit_diff
!iv_line_index TYPE string
RETURNING
VALUE(rs_diff) TYPE zif_abapgit_definitions=>ty_diff
RAISING
zcx_abapgit_exception .
CLASS-METHODS is_patch_line_possible
IMPORTING
!is_diff_line TYPE zif_abapgit_definitions=>ty_diff
RETURNING
VALUE(rv_is_patch_line_possible) TYPE abap_bool .
METHODS render_scripts
RETURNING
VALUE(ri_html) TYPE REF TO zif_abapgit_html
RAISING
zcx_abapgit_exception .
ENDCLASS.
CLASS zcl_abapgit_gui_page_patch IMPLEMENTATION.
METHOD add_menu_begin.
io_menu->add(
iv_txt = c_action_texts-refresh_local
iv_typ = zif_abapgit_html=>c_action_type-dummy
iv_act = c_actions-refresh_local
iv_id = c_actions-refresh_local
iv_title = c_action_titles-refresh_local ).
io_menu->add(
iv_txt = c_action_texts-refresh_all
iv_typ = zif_abapgit_html=>c_action_type-dummy
iv_act = c_actions-refresh_all
iv_id = c_actions-refresh_all
iv_title = c_action_titles-refresh_all ).
ENDMETHOD.
METHOD add_menu_end.
io_menu->add( iv_txt = 'Stage'
iv_act = c_patch_actions-stage
iv_id = 'stage'
iv_typ = zif_abapgit_html=>c_action_type-dummy ).
add_view_sub_menu( io_menu ).
ENDMETHOD.
METHOD add_to_stage.
DATA: lt_diff TYPE zif_abapgit_definitions=>ty_diffs_tt,
lv_something_patched TYPE abap_bool,
ls_status TYPE zif_abapgit_definitions=>ty_result,
lv_patch TYPE xstring,
lo_git_add_patch TYPE REF TO zcl_abapgit_git_add_patch.
FIELD-SYMBOLS: <ls_diff_file> TYPE ty_file_diff.
LOOP AT mt_diff_files ASSIGNING <ls_diff_file>.
IF <ls_diff_file>-o_diff IS NOT BOUND.
" When we deal with binary files we don't have a diff object.
" There's nothing to do because they cannot be patched
CONTINUE.
ENDIF.
lt_diff = <ls_diff_file>-o_diff->get( ).
READ TABLE lt_diff TRANSPORTING NO FIELDS
WITH KEY patch_flag = abap_true.
CHECK sy-subrc = 0.
lv_something_patched = abap_true.
CREATE OBJECT lo_git_add_patch
EXPORTING
it_diff = <ls_diff_file>-o_diff->get( ).
lv_patch = lo_git_add_patch->get_patch_binary( ).
IF <ls_diff_file>-lstate = 'D' AND are_all_lines_patched( lt_diff ) = abap_true.
ls_status-lstate = zif_abapgit_definitions=>c_state-deleted.
mo_stage->rm(
iv_path = <ls_diff_file>-path
is_status = ls_status
iv_filename = <ls_diff_file>-filename ).
ELSE.
IF <ls_diff_file>-lstate = 'A' AND are_all_lines_patched( lt_diff ) = abap_true.
ls_status-lstate = zif_abapgit_definitions=>c_state-added.
ELSE.
ls_status-lstate = zif_abapgit_definitions=>c_state-modified.
ENDIF.
mo_stage->add(
iv_path = <ls_diff_file>-path
iv_filename = <ls_diff_file>-filename
is_status = ls_status
iv_data = lv_patch ).
ENDIF.
ENDLOOP.
IF lv_something_patched = abap_false.
zcx_abapgit_exception=>raise( |Nothing added| ).
ENDIF.
ENDMETHOD.
METHOD apply_patch_all.
DATA: lv_filename TYPE string,
lt_patch TYPE string_table,
lv_line_index TYPE string.
FIELD-SYMBOLS: <lv_patch> TYPE LINE OF string_table.
SPLIT iv_patch AT ',' INTO TABLE lt_patch.
LOOP AT lt_patch ASSIGNING <lv_patch>.
get_patch_data(
EXPORTING
iv_patch = <lv_patch>
IMPORTING
ev_filename = lv_filename
ev_line_index = lv_line_index ).
apply_patch_for( iv_filename = lv_filename
iv_line_index = lv_line_index
iv_patch_flag = iv_patch_flag ).
ENDLOOP.
ENDMETHOD.
METHOD apply_patch_for.
DATA: lo_diff TYPE REF TO zcl_abapgit_diff,
ls_diff_line TYPE zif_abapgit_definitions=>ty_diff,
lv_line TYPE i.
lo_diff = get_diff_object( iv_filename ).
ls_diff_line = get_diff_line( io_diff = lo_diff
iv_line_index = iv_line_index ).
CASE ls_diff_line-result.
WHEN zif_abapgit_definitions=>c_diff-update
OR zif_abapgit_definitions=>c_diff-insert.
lv_line = ls_diff_line-new_num.
lo_diff->set_patch_new( iv_line_new = lv_line
iv_patch_flag = iv_patch_flag ).
WHEN zif_abapgit_definitions=>c_diff-delete.
lv_line = ls_diff_line-old_num.
lo_diff->set_patch_old( iv_line_old = lv_line
iv_patch_flag = iv_patch_flag ).
ENDCASE.
ENDMETHOD.
METHOD apply_patch_from_form_fields.
DATA:
lv_add TYPE string,
lv_remove TYPE string.
lv_add = ii_event->form_data( )->get( c_patch_action-add ).
lv_remove = ii_event->form_data( )->get( c_patch_action-remove ).
apply_patch_all( iv_patch = lv_add
iv_patch_flag = abap_true ).
apply_patch_all( iv_patch = lv_remove
iv_patch_flag = abap_false ).
ENDMETHOD.
METHOD are_all_lines_patched.
DATA: lv_patch_count TYPE i.
FIELD-SYMBOLS: <ls_diff> TYPE zif_abapgit_definitions=>ty_diff.
LOOP AT it_diff ASSIGNING <ls_diff>
WHERE patch_flag = abap_true.
lv_patch_count = lv_patch_count + 1.
ENDLOOP.
rv_are_all_lines_patched = boolc( lv_patch_count = lines( it_diff ) ).
ENDMETHOD.
METHOD constructor.
super->constructor(
iv_key = iv_key
is_file = is_file
is_object = is_object
it_files = it_files ).
IF mi_repo->is_offline( ) = abap_true.
zcx_abapgit_exception=>raise( |Patching is only possible for online repositories.| ).
ENDIF.
mi_repo_online ?= mi_repo.
" While patching we always want to be in split mode
CLEAR: mv_unified.
CREATE OBJECT mo_stage.
ENDMETHOD.
METHOD create.
DATA lo_component TYPE REF TO zcl_abapgit_gui_page_patch.
CREATE OBJECT lo_component
EXPORTING
iv_key = iv_key
is_file = is_file
is_object = is_object
it_files = it_files.
ri_page = zcl_abapgit_gui_page_hoc=>create(
iv_page_title = 'Patch'
iv_page_layout = zcl_abapgit_gui_page=>c_page_layout-full_width
ii_page_menu_provider = lo_component
ii_child_component = lo_component ).
ENDMETHOD.
METHOD get_diff_line.
DATA: lt_diff TYPE zif_abapgit_definitions=>ty_diffs_tt,
lv_line_index TYPE sy-tabix.
lv_line_index = iv_line_index.
lt_diff = io_diff->get( ).
READ TABLE lt_diff INTO rs_diff
INDEX lv_line_index.
IF sy-subrc <> 0.
zcx_abapgit_exception=>raise( |Invalid line index { lv_line_index }| ).
ENDIF.
ENDMETHOD.
METHOD get_diff_object.
FIELD-SYMBOLS: <ls_diff_file> LIKE LINE OF mt_diff_files.
LOOP AT mt_diff_files ASSIGNING <ls_diff_file>.
IF get_normalized_fname_with_path( <ls_diff_file> ) = iv_filename.
ro_diff = <ls_diff_file>-o_diff.
EXIT.
ENDIF.
ENDLOOP.
IF ro_diff IS NOT BOUND.
zcx_abapgit_exception=>raise( |Invalid filename { iv_filename }| ).
ENDIF.
ENDMETHOD.
METHOD get_patch_data.
DATA: lv_section TYPE string.
CLEAR: ev_filename, ev_line_index.
FIND FIRST OCCURRENCE OF REGEX `patch_line` && `_(.*)_(\d)+_(\d+)`
IN iv_patch
SUBMATCHES ev_filename lv_section ev_line_index.
IF sy-subrc <> 0.
zcx_abapgit_exception=>raise( |Invalid patch| ).
ENDIF.
ENDMETHOD.
METHOD insert_nav.
" add beacon at beginning of file
rv_insert_nav = abap_true.
ENDMETHOD.
METHOD is_patch_line_possible.
IF is_diff_line-result = zif_abapgit_definitions=>c_diff-update
OR is_diff_line-result = zif_abapgit_definitions=>c_diff-insert
OR is_diff_line-result = zif_abapgit_definitions=>c_diff-delete.
rv_is_patch_line_possible = abap_true.
ENDIF.
ENDMETHOD.
METHOD refresh.
DATA: lt_diff_files_old TYPE ty_file_diffs.
lt_diff_files_old = mt_diff_files.
super->refresh( iv_action ).
restore_patch_flags( lt_diff_files_old ).
ENDMETHOD.
METHOD render_beacon_begin_of_row.
mv_section_count = mv_section_count + 1.
ii_html->add( |<th class="patch">| ).
ii_html->add_checkbox( |patch_section_{ get_normalized_fname_with_path( is_diff ) }_{ mv_section_count }| ).
ii_html->add( '</th>' ).
ENDMETHOD.
METHOD render_diff_head_after_state.
DATA: lv_act_id TYPE string.
lv_act_id = |{ c_actions-refresh_local_object }_{ is_diff-obj_type }_{ is_diff-obj_name }|.
IF is_diff-obj_type IS NOT INITIAL AND is_diff-obj_name IS NOT INITIAL.
" Dummy link is handled in JS (based on ID)
ii_html->add( '<span class="repo_name">' ).
ii_html->add_a( iv_txt = ii_html->icon( iv_name = 'redo-alt-solid'
iv_class = 'pad-sides'
iv_hint = 'Local refresh of this object' )
iv_id = lv_act_id
iv_act = lv_act_id
iv_typ = zif_abapgit_html=>c_action_type-dummy
iv_class = |url| ).
ii_html->add( '</span>' ).
ENDIF.
ENDMETHOD.
METHOD render_line_split_row.
render_patch( ii_html = ii_html
iv_filename = iv_filename
is_diff_line = is_diff_line
iv_index = iv_index ).
super->render_line_split_row(
ii_html = ii_html
iv_filename = iv_filename
is_diff_line = is_diff_line
iv_index = iv_index
iv_fstate = iv_fstate
iv_new = iv_new
iv_old = iv_old ).
ENDMETHOD.
METHOD render_patch.
CONSTANTS:
BEGIN OF lc_css_class,
patch TYPE string VALUE `patch`,
END OF lc_css_class.
DATA:
lv_id TYPE string,
lv_patched TYPE abap_bool,
lv_is_patch_possible TYPE abap_bool.
" In case an object is falsely detected as changed, filename is empty and there's no diff object
IF iv_filename IS NOT INITIAL.
lv_patched = get_diff_object( iv_filename )->is_line_patched( iv_index ).
ENDIF.
lv_is_patch_possible = is_patch_line_possible( is_diff_line ).
IF lv_is_patch_possible = abap_true.
lv_id = |{ iv_filename }_{ mv_section_count }_{ iv_index }|.
ii_html->add( |<td class="{ lc_css_class-patch }">| ).
ii_html->add_checkbox(
iv_id = |patch_line_{ lv_id }|
iv_checked = lv_patched ).
ii_html->add( |</td>| ).
ELSE.
ii_html->add( |<td class="{ lc_css_class-patch }">| ).
ii_html->add( |</td>| ).
ENDIF.
ENDMETHOD.
METHOD render_patch_head.
ii_html->add( |<th class="patch">| ).
ii_html->add_checkbox( |patch_file_{ get_normalized_fname_with_path( is_diff ) }| ).
ii_html->add( '</th>' ).
ENDMETHOD.
METHOD render_scripts.
CREATE OBJECT ri_html TYPE zcl_abapgit_html.
ri_html->set_title( cl_abap_typedescr=>describe_by_object_ref( me )->get_relative_name( ) ).
ri_html->add( 'preparePatch();' ).
ri_html->add( 'registerStagePatch();' ).
ENDMETHOD.
METHOD render_table_head_non_unified.
render_patch_head( ii_html = ii_html
is_diff = is_diff ).
super->render_table_head_non_unified(
ii_html = ii_html
is_diff = is_diff ).
ENDMETHOD.
METHOD restore_patch_flags.
DATA:
lt_diff_old TYPE zif_abapgit_definitions=>ty_diffs_tt.
FIELD-SYMBOLS:
<ls_diff_file> TYPE ty_file_diff,
<ls_diff_file_old> TYPE ty_file_diff,
<ls_diff_old> TYPE zif_abapgit_definitions=>ty_diff.
LOOP AT mt_diff_files ASSIGNING <ls_diff_file>.
READ TABLE it_diff_files_old ASSIGNING <ls_diff_file_old>
WITH KEY secondary
COMPONENTS path = <ls_diff_file>-path
filename = <ls_diff_file>-filename.
IF sy-subrc <> 0.
CONTINUE. " e.g. new objects
ENDIF.
IF <ls_diff_file_old>-o_diff IS NOT BOUND.
CONTINUE. " e.g. binary files
ENDIF.
lt_diff_old = <ls_diff_file_old>-o_diff->get( ).
LOOP AT lt_diff_old ASSIGNING <ls_diff_old>
WHERE patch_flag = abap_true.
<ls_diff_file>-o_diff->set_patch_by_old_diff(
is_diff_old = <ls_diff_old>
iv_patch_flag = abap_true ).
ENDLOOP.
ENDLOOP.
ENDMETHOD.
METHOD start_staging.
apply_patch_from_form_fields( ii_event ).
add_to_stage( ).
ENDMETHOD.
METHOD zif_abapgit_gui_event_handler~on_event.
CASE ii_event->mv_action.
WHEN c_patch_actions-stage.
start_staging( ii_event ).
rs_handled-page = zcl_abapgit_gui_page_commit=>create(
ii_repo_online = mi_repo_online
io_stage = mo_stage ).
rs_handled-state = zcl_abapgit_gui=>c_event_state-new_page.
WHEN OTHERS.
IF is_refresh( ii_event->mv_action ) = abap_true.
apply_patch_from_form_fields( ii_event ).
refresh( ii_event->mv_action ).
rs_handled-state = zcl_abapgit_gui=>c_event_state-re_render.
ELSE.
rs_handled = super->zif_abapgit_gui_event_handler~on_event( ii_event ).
ENDIF.
ENDCASE.
ENDMETHOD.
METHOD zif_abapgit_gui_hotkeys~get_hotkey_actions.
DATA ls_hotkey_action LIKE LINE OF rt_hotkey_actions.
ls_hotkey_action-ui_component = 'Patch'.
ls_hotkey_action-description = |Stage Changes|.
ls_hotkey_action-action = |stagePatch|.
ls_hotkey_action-hotkey = |s|.
INSERT ls_hotkey_action INTO TABLE rt_hotkey_actions.
ls_hotkey_action-description = |Refresh Local|.
ls_hotkey_action-action = |refreshLocal|.
ls_hotkey_action-hotkey = |r|.
INSERT ls_hotkey_action INTO TABLE rt_hotkey_actions.
ls_hotkey_action-description = |Refresh All|.
ls_hotkey_action-action = |refreshAll|.
ls_hotkey_action-hotkey = |a|.
INSERT ls_hotkey_action INTO TABLE rt_hotkey_actions.
ENDMETHOD.
METHOD zif_abapgit_gui_renderable~render.
CLEAR mv_section_count.
IF mv_pushed = abap_true.
refresh_full( ).
calculate_diff( ).
CLEAR mv_pushed.
ENDIF.
register_handlers( ).
ri_html = super->zif_abapgit_gui_renderable~render( ).
register_deferred_script( render_scripts( ) ).
ENDMETHOD.
ENDCLASS.
Reference in New Issue View Git Blame Copy Permalink