2014-06-07 08:46:58 -04:00
module BlobHelper
2016-06-15 14:52:23 -04:00
def highlight ( blob_name , blob_content , repository : nil , plain : false )
highlighted = Gitlab :: Highlight . highlight ( blob_name , blob_content , plain : plain , repository : repository )
2016-07-15 01:43:49 -04:00
raw %( <pre class="code highlight"><code> #{ highlighted } </code></pre> )
2014-06-07 08:46:58 -04:00
end
def no_highlight_files
2014-12-03 06:50:00 -05:00
%w( credits changelog news copying copyright license authors )
2014-06-07 08:46:58 -04:00
end
2015-01-26 18:03:14 -05:00
2015-12-18 04:03:34 -05:00
def edit_blob_link ( project = @project , ref = @ref , path = @path , options = { } )
return unless current_user
2016-08-17 11:05:00 -04:00
blob = options . delete ( :blob )
blob || = project . repository . blob_at ( ref , path ) rescue nil
2015-12-18 04:03:34 -05:00
2016-07-30 00:04:04 -04:00
return unless blob
2015-12-18 04:03:34 -05:00
edit_path = namespace_project_edit_blob_path ( project . namespace , project ,
tree_join ( ref , path ) ,
2016-08-17 11:05:00 -04:00
options [ :link_opts ] )
2015-12-18 04:03:34 -05:00
2016-01-21 16:46:49 -05:00
if ! on_top_of_branch? ( project , ref )
2016-04-01 15:27:39 -04:00
button_tag " Edit " , class : " btn disabled has-tooltip btn-file-option " , title : " You can only edit files when you are on a branch " , data : { container : 'body' }
2016-01-21 16:46:49 -05:00
elsif can_edit_blob? ( blob , project , ref )
2016-06-21 07:27:20 -04:00
link_to " Edit " , edit_path , class : 'btn btn-sm'
2015-12-18 04:03:34 -05:00
elsif can? ( current_user , :fork_project , project )
continue_params = {
to : edit_path ,
notice : edit_in_new_fork_notice ,
notice_now : edit_in_new_fork_notice_now
}
2016-01-11 21:50:02 -05:00
fork_path = namespace_project_forks_path ( project . namespace , project , namespace_key : current_user . namespace . id , continue : continue_params )
2015-12-18 04:03:34 -05:00
2016-04-01 15:27:39 -04:00
link_to " Edit " , fork_path , class : 'btn btn-file-option' , method : :post
2015-12-18 04:03:34 -05:00
end
end
def modify_file_link ( project = @project , ref = @ref , path = @path , label : , action : , btn_class : , modal_type : )
return unless current_user
blob = project . repository . blob_at ( ref , path ) rescue nil
return unless blob
2016-01-21 16:46:49 -05:00
if ! on_top_of_branch? ( project , ref )
2016-03-20 15:01:46 -04:00
button_tag label , class : " btn btn- #{ btn_class } disabled has-tooltip " , title : " You can only #{ action } files when you are on a branch " , data : { container : 'body' }
2015-12-18 10:14:12 -05:00
elsif blob . lfs_pointer?
2016-03-20 15:01:46 -04:00
button_tag label , class : " btn btn- #{ btn_class } disabled has-tooltip " , title : " It is not possible to #{ action } files that are stored in LFS using the web interface " , data : { container : 'body' }
2016-01-21 16:46:49 -05:00
elsif can_edit_blob? ( blob , project , ref )
2015-12-18 04:03:34 -05:00
button_tag label , class : " btn btn- #{ btn_class } " , 'data-target' = > " # modal- #{ modal_type } -blob " , 'data-toggle' = > 'modal'
elsif can? ( current_user , :fork_project , project )
continue_params = {
to : request . fullpath ,
notice : edit_in_new_fork_notice + " Try to #{ action } this file again. " ,
notice_now : edit_in_new_fork_notice_now
}
2016-01-11 21:50:02 -05:00
fork_path = namespace_project_forks_path ( project . namespace , project , namespace_key : current_user . namespace . id , continue : continue_params )
2015-12-18 04:03:34 -05:00
link_to label , fork_path , class : " btn btn- #{ btn_class } " , method : :post
end
end
def replace_blob_link ( project = @project , ref = @ref , path = @path )
modify_file_link (
project ,
ref ,
path ,
label : " Replace " ,
action : " replace " ,
btn_class : " default " ,
modal_type : " upload "
)
end
def delete_blob_link ( project = @project , ref = @ref , path = @path )
modify_file_link (
project ,
ref ,
path ,
label : " Delete " ,
action : " delete " ,
btn_class : " remove " ,
modal_type : " remove "
)
end
def can_edit_blob? ( blob , project = @project , ref = @ref )
! blob . lfs_pointer? && can_edit_tree? ( project , ref )
2015-01-26 18:03:14 -05:00
end
def leave_edit_message
" Leave edit mode? \n All unsaved changes will be lost. "
end
def editing_preview_title ( filename )
2015-05-12 19:40:11 -04:00
if Gitlab :: MarkupHelper . previewable? ( filename )
2015-01-26 18:03:14 -05:00
'Preview'
else
2015-12-02 08:53:11 -05:00
'Preview Changes'
2015-01-26 18:03:14 -05:00
end
end
2014-10-04 06:29:18 -04:00
# Return an image icon depending on the file mode and extension
#
# mode - File unix mode
# mode - File name
def blob_icon ( mode , name )
icon ( " #{ file_type_icon_class ( 'file' , mode , name ) } fw " )
end
2015-12-07 09:03:50 -05:00
2015-12-18 10:14:12 -05:00
def blob_text_viewable? ( blob )
2016-05-24 01:59:35 -04:00
blob && blob . text? && ! blob . lfs_pointer? && ! blob . only_display_raw?
2015-12-07 09:03:50 -05:00
end
def blob_size ( blob )
if blob . lfs_pointer?
blob . lfs_size
else
blob . size
end
end
2015-09-12 23:54:06 -04:00
# SVGs can contain malicious JavaScript; only include whitelisted
# elements and attributes. Note that this whitelist is by no means complete
# and may omit some elements.
def sanitize_svg ( blob )
2016-03-25 01:39:58 -04:00
blob . data = Gitlab :: Sanitizers :: SVG . clean ( blob . data )
2015-09-12 23:54:06 -04:00
blob
end
2016-02-24 05:53:30 -05:00
# If we blindly set the 'real' content type when serving a Git blob we
# are enabling XSS attacks. An attacker could upload e.g. a Javascript
# file to a Git repository, trick the browser of a victim into
# downloading the blob, and then the 'application/javascript' content
# type would tell the browser to execute the attacker's Javascript. By
# overriding the content type and setting it to 'text/plain' (in the
# example of Javascript) we tell the browser of the victim not to
# execute untrusted data.
def safe_content_type ( blob )
if blob . text?
'text/plain; charset=utf-8'
elsif blob . image?
blob . content_type
else
'application/octet-stream'
end
end
2016-03-03 11:59:47 -05:00
2016-03-07 08:27:53 -05:00
def cached_blob?
stale = stale? ( etag : @blob . id ) # The #stale? method sets cache headers.
# Because we are opionated we set the cache headers ourselves.
2016-03-07 10:49:46 -05:00
response . cache_control [ :public ] = @project . public?
2016-03-03 11:59:47 -05:00
if @ref && @commit && @ref == @commit . id
# This is a link to a commit by its commit SHA. That means that the blob
2016-03-07 08:27:53 -05:00
# is immutable. The only reason to invalidate the cache is if the commit
# was deleted or if the user lost access to the repository.
2016-03-07 10:49:46 -05:00
response . cache_control [ :max_age ] = Blob :: CACHE_TIME_IMMUTABLE
2016-03-03 11:59:47 -05:00
else
# A branch or tag points at this blob. That means that the expected blob
# value may change over time.
2016-03-07 10:49:46 -05:00
response . cache_control [ :max_age ] = Blob :: CACHE_TIME
2016-03-03 11:59:47 -05:00
end
2016-03-07 10:49:46 -05:00
response . etag = @blob . id
2016-03-07 08:27:53 -05:00
! stale
2016-03-03 11:59:47 -05:00
end
2016-04-11 09:49:25 -04:00
def licenses_for_select
return @licenses_for_select if defined? ( @licenses_for_select )
licenses = Licensee :: License . all
@licenses_for_select = {
2016-06-15 03:12:42 -04:00
Popular : licenses . select ( & :featured ) . map { | license | { name : license . name , id : license . key } } ,
Other : licenses . reject ( & :featured ) . map { | license | { name : license . name , id : license . key } }
2016-04-11 09:49:25 -04:00
}
end
2016-04-29 10:25:03 -04:00
2016-06-24 15:43:46 -04:00
def selected_template ( issuable )
templates = issuable_templates ( issuable )
params [ :issuable_template ] if templates . include? ( params [ :issuable_template ] )
end
def can_add_template? ( issuable )
names = issuable_templates ( issuable )
names . empty? && can? ( current_user , :push_code , @project ) && ! @project . private?
end
def merge_request_template_names
@merge_request_templates || = Gitlab :: Template :: MergeRequestTemplate . dropdown_names ( ref_project )
end
def issue_template_names
@issue_templates || = Gitlab :: Template :: IssueTemplate . dropdown_names ( ref_project )
end
def issuable_templates ( issuable )
@issuable_templates || =
if issuable . is_a? ( Issue )
issue_template_names
elsif issuable . is_a? ( MergeRequest )
merge_request_template_names
end
end
def ref_project
@ref_project || = @target_project || @project
end
2016-05-13 11:57:03 -04:00
def gitignore_names
2016-06-24 15:43:46 -04:00
@gitignore_names || = Gitlab :: Template :: GitignoreTemplate . dropdown_names
2016-06-02 12:20:08 -04:00
end
2016-05-11 20:38:43 -04:00
2016-06-02 12:20:08 -04:00
def gitlab_ci_ymls
2016-06-24 15:43:46 -04:00
@gitlab_ci_ymls || = Gitlab :: Template :: GitlabCiYmlTemplate . dropdown_names
2016-04-29 10:25:03 -04:00
end
2014-06-07 08:46:58 -04:00
end