Mercurial > wow > wowdb-profiler

annotate Comments.lua @ 263:03f1fbe64104

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
The Submit button now attaches comments to the appropriate DB entries.
author James D. Callahan III <jcallahan@curse.com>
date Tue, 19 Mar 2013 14:51:50 -0500
parents 7f5982e01953
children 58b090074eda
rev   line source
jcallahan@249 1 -- LUA API ------------------------------------------------------------
jcallahan@249 2
jcallahan@249 3 local _G = getfenv(0)
jcallahan@249 4
jcallahan@249 5 local table = _G.table
jcallahan@249 6
jcallahan@249 7 -- ADDON NAMESPACE ----------------------------------------------------
jcallahan@249 8
jcallahan@249 9 local ADDON_NAME, private = ...
jcallahan@249 10
jcallahan@249 11 local LibStub = _G.LibStub
jcallahan@249 12 local WDP = LibStub("AceAddon-3.0"):GetAddon(ADDON_NAME)
jcallahan@259 13 local Dialog = LibStub("LibDialog-1.0")
jcallahan@249 14
jcallahan@249 15 local ParseGUID = private.ParseGUID
jcallahan@260 16 local ItemLinkToID = private.ItemLinkToID
jcallahan@263 17 local DBEntry = private.DBEntry
jcallahan@249 18
jcallahan@258 19 -- CONSTANTS ----------------------------------------------------------
jcallahan@258 20
jcallahan@258 21 local EDIT_MAXCHARS = 3000
jcallahan@259 22 local EDIT_DESCRIPTION_FORMAT = "Enter your comment below, being as descriptive as possible. Comments are limited to %s characters, including newlines and spaces."
jcallahan@259 23 local LINK_COMMENT_TOOLTIP = "Click here to create a link to the comment page on WoWDB."
jcallahan@261 24 local LINK_EDITBOX_DESC_FORMAT = "Copy the highlighted text and paste it into your browser to visit the comments for |cffffd200%s|r."
jcallahan@259 25
jcallahan@259 26 local URL_BASE = "http://www.wowdb.com/"
jcallahan@259 27
jcallahan@259 28 local URL_TYPE_MAP = {
jcallahan@259 29 ITEM = "items",
jcallahan@259 30 OBJECT = "objects",
jcallahan@259 31 NPC = "npcs",
jcallahan@261 32 QUEST = "quests",
jcallahan@260 33 SPELL = "spells",
jcallahan@259 34 VEHICLE = "npcs",
jcallahan@259 35 }
jcallahan@259 36
jcallahan@259 37 Dialog:Register("WDP_CommentLink", {
jcallahan@259 38 text = "",
jcallahan@259 39 editboxes = {
jcallahan@259 40 {
jcallahan@259 41 text = _G.UNKNOWN,
jcallahan@259 42 on_escape_pressed = function(self)
jcallahan@259 43 self:ClearFocus()
jcallahan@259 44 end,
jcallahan@259 45 },
jcallahan@259 46 },
jcallahan@259 47 buttons = {
jcallahan@259 48 {
jcallahan@259 49 text = _G.OKAY,
jcallahan@259 50 }
jcallahan@259 51 },
jcallahan@259 52 show_while_dead = true,
jcallahan@259 53 hide_on_escape = true,
jcallahan@259 54 is_exclusive = true,
jcallahan@259 55 on_show = function(self, data)
jcallahan@259 56 local editbox = self.editboxes[1]
jcallahan@259 57 editbox:SetWidth(self:GetWidth() - 20)
jcallahan@259 58 editbox:SetText(("%s%s/%d#related:comments"):format(URL_BASE, URL_TYPE_MAP[data.type_name], data.id))
jcallahan@259 59 editbox:HighlightText()
jcallahan@259 60 editbox:SetFocus()
jcallahan@259 61
jcallahan@261 62 self.text:SetJustifyH("LEFT")
jcallahan@259 63 self.text:SetFormattedText(LINK_EDITBOX_DESC_FORMAT:format(data.label))
jcallahan@259 64 end,
jcallahan@259 65 })
jcallahan@259 66
jcallahan@259 67 local comment_subject = {}
jcallahan@258 68
jcallahan@249 69 -- HELPERS ------------------------------------------------------------
jcallahan@249 70
jcallahan@249 71 local comment_frame
jcallahan@249 72 do
jcallahan@249 73 local panel = _G.CreateFrame("Frame", "WDP_CommentFrame", _G.UIParent, "TranslucentFrameTemplate")
jcallahan@258 74 panel:SetSize(480, 350)
jcallahan@249 75 panel:SetPoint("CENTER", _G.UIParent, "CENTER")
jcallahan@249 76 panel:SetFrameStrata("DIALOG")
jcallahan@249 77 panel.Bg:SetTexture([[Interface\FrameGeneral\UI-Background-Rock]], true, true)
jcallahan@249 78 panel.Bg:SetHorizTile(true)
jcallahan@249 79 panel.Bg:SetVertTile(true)
jcallahan@249 80 panel:Hide()
jcallahan@249 81 comment_frame = panel
jcallahan@249 82
jcallahan@249 83 table.insert(_G.UISpecialFrames, panel:GetName())
jcallahan@249 84
jcallahan@249 85 local streaks = panel:CreateTexture("$parentTopTileStreaks", "BORDER", "_UI-Frame-TopTileStreaks", -6)
jcallahan@249 86 streaks:SetPoint("TOPLEFT", 13, -13)
jcallahan@249 87 streaks:SetPoint("BOTTOMRIGHT", panel, "TOPRIGHT", -13, -35)
jcallahan@249 88
jcallahan@249 89 local header = _G.CreateFrame("Frame", "$parentHeader", panel, "TranslucentFrameTemplate")
jcallahan@249 90 header:SetSize(128, 64)
jcallahan@249 91 header:SetPoint("CENTER", panel, "TOP", 0, -8)
jcallahan@249 92 header.Bg:SetTexture([[Interface\FrameGeneral\UI-Background-Marble]])
jcallahan@249 93 header.Bg:SetHorizTile(true)
jcallahan@249 94 header.Bg:SetVertTile(true)
jcallahan@249 95 panel.header = header
jcallahan@249 96
jcallahan@249 97 local logo = header:CreateTexture(nil, "ARTWORK")
jcallahan@249 98 logo:SetTexture([[Interface\AddOns\WoWDBProfiler\wowdb-logo]])
jcallahan@249 99 logo:SetPoint("TOPLEFT", header, 10, -10)
jcallahan@249 100 logo:SetPoint("BOTTOMRIGHT", header, -10, 10)
jcallahan@249 101
jcallahan@258 102 local subject_name = panel:CreateFontString(nil, "ARTWORK", "GameFontNormal")
jcallahan@258 103 subject_name:SetPoint("TOP", header, "BOTTOM", 0, -10)
jcallahan@258 104 panel.subject_name = subject_name
jcallahan@258 105
jcallahan@258 106 local subject_data = panel:CreateFontString(nil, "ARTWORK", "GameFontNormal")
jcallahan@258 107 subject_data:SetPoint("TOP", subject_name, "BOTTOM", 0, -3)
jcallahan@258 108 panel.subject_data = subject_data
jcallahan@249 109
jcallahan@249 110 local close = _G.CreateFrame("Button", nil, panel, "UIPanelCloseButton")
jcallahan@249 111 close:SetPoint("TOPRIGHT", panel, "TOPRIGHT", -7, -7)
jcallahan@249 112
jcallahan@249 113 local scroll_frame = _G.CreateFrame("ScrollFrame", "$parentScrollFrame", panel)
jcallahan@249 114 scroll_frame:SetSize(435, 150)
jcallahan@249 115 scroll_frame:SetPoint("BOTTOM", 0, 70)
jcallahan@249 116
jcallahan@249 117 scroll_frame:SetScript("OnScrollRangeChanged", function(self, x, y)
jcallahan@249 118 _G.ScrollFrame_OnScrollRangeChanged(self, x, y)
jcallahan@249 119 end)
jcallahan@249 120
jcallahan@249 121 scroll_frame:SetScript("OnVerticalScroll", function(self, offset)
jcallahan@249 122 local scrollbar = self.ScrollBar
jcallahan@249 123 scrollbar:SetValue(offset)
jcallahan@249 124
jcallahan@249 125 local min, max = scrollbar:GetMinMaxValues()
jcallahan@249 126
jcallahan@249 127 if offset == 0 then
jcallahan@249 128 scrollbar.ScrollUpButton:Disable()
jcallahan@249 129 else
jcallahan@249 130 scrollbar.ScrollUpButton:Enable()
jcallahan@249 131 end
jcallahan@249 132
jcallahan@249 133 if (scrollbar:GetValue() - max) == 0 then
jcallahan@249 134 scrollbar.ScrollDownButton:Disable()
jcallahan@249 135 else
jcallahan@249 136 scrollbar.ScrollDownButton:Enable()
jcallahan@249 137 end
jcallahan@249 138 end)
jcallahan@249 139
jcallahan@249 140 scroll_frame:SetScript("OnMouseWheel", function(self, delta)
jcallahan@249 141 _G.ScrollFrameTemplate_OnMouseWheel(self, delta)
jcallahan@249 142 end)
jcallahan@249 143
jcallahan@258 144 panel.scroll_frame = scroll_frame
jcallahan@258 145
jcallahan@249 146 local edit_container = _G.CreateFrame("Frame", nil, scroll_frame)
jcallahan@249 147 edit_container:SetPoint("TOPLEFT", scroll_frame, -7, 7)
jcallahan@249 148 edit_container:SetPoint("BOTTOMRIGHT", scroll_frame, 7, -7)
jcallahan@249 149 edit_container:SetFrameLevel(scroll_frame:GetFrameLevel() - 1)
jcallahan@249 150 edit_container:SetBackdrop({
jcallahan@249 151 bgFile = [[Interface\Tooltips\UI-Tooltip-Background]],
jcallahan@249 152 edgeFile = [[Interface\Tooltips\UI-Tooltip-Border]],
jcallahan@249 153 tile = true,
jcallahan@249 154 tileSize = 16,
jcallahan@249 155 edgeSize = 16,
jcallahan@249 156 insets = {
jcallahan@249 157 left = 5,
jcallahan@249 158 right = 5,
jcallahan@249 159 top = 5,
jcallahan@249 160 bottom = 5
jcallahan@249 161 }
jcallahan@249 162 })
jcallahan@249 163
jcallahan@249 164 edit_container:SetBackdropBorderColor(_G.TOOLTIP_DEFAULT_COLOR.r, _G.TOOLTIP_DEFAULT_COLOR.g, _G.TOOLTIP_DEFAULT_COLOR.b)
jcallahan@249 165 edit_container:SetBackdropColor(0, 0, 0)
jcallahan@249 166
jcallahan@259 167 local link_button = _G.CreateFrame("Button", "$parentLinkButton", panel)
jcallahan@259 168 link_button:SetSize(32, 16)
jcallahan@259 169 link_button:SetPoint("TOPRIGHT", edit_container, "BOTTOMRIGHT", 5, 0)
jcallahan@259 170
jcallahan@259 171 link_button:SetNormalTexture([[Interface\TradeSkillFrame\UI-TradeSkill-LinkButton]])
jcallahan@259 172 link_button:GetNormalTexture():SetTexCoord(0, 1, 0, 0.5)
jcallahan@259 173
jcallahan@259 174 link_button:SetHighlightTexture([[Interface\TradeSkillFrame\UI-TradeSkill-LinkButton]])
jcallahan@259 175 link_button:GetHighlightTexture():SetTexCoord(0, 1, 0.5, 1)
jcallahan@259 176
jcallahan@259 177 link_button:SetScript("OnClick", function(self)
jcallahan@259 178 Dialog:Spawn("WDP_CommentLink", { type_name = comment_subject.type_name, id = comment_subject.id, label = comment_subject.label })
jcallahan@259 179 end)
jcallahan@259 180
jcallahan@259 181 link_button:SetScript("OnEnter", function(self)
jcallahan@259 182 _G.GameTooltip:SetOwner(self, "ANCHOR_TOPLEFT")
jcallahan@259 183 _G.GameTooltip:SetText(LINK_COMMENT_TOOLTIP, nil, nil, nil, nil, 1)
jcallahan@259 184 _G.GameTooltip:Show()
jcallahan@259 185 end)
jcallahan@259 186
jcallahan@259 187 link_button:SetScript("OnLeave", _G.GameTooltip_Hide)
jcallahan@259 188
jcallahan@258 189 local edit_description = edit_container:CreateFontString("MUFASA", "ARTWORK", "GameFontHighlight")
jcallahan@258 190 edit_description:SetHeight(36)
jcallahan@258 191 edit_description:SetPoint("BOTTOMLEFT", edit_container, "TOPLEFT", 5, 3)
jcallahan@258 192 edit_description:SetPoint("BOTTOMRIGHT", edit_container, "TOPRIGHT", 5, 3)
jcallahan@258 193 edit_description:SetFormattedText(EDIT_DESCRIPTION_FORMAT, _G.BreakUpLargeNumbers(EDIT_MAXCHARS))
jcallahan@258 194 edit_description:SetWordWrap(true)
jcallahan@258 195 edit_description:SetJustifyH("LEFT")
jcallahan@258 196
jcallahan@249 197 local edit_box = _G.CreateFrame("EditBox", nil, scroll_frame)
jcallahan@249 198 edit_box:SetMultiLine(true)
jcallahan@258 199 edit_box:SetMaxLetters(EDIT_MAXCHARS)
jcallahan@249 200 edit_box:EnableMouse(true)
jcallahan@249 201 edit_box:SetAutoFocus(false)
jcallahan@249 202 edit_box:SetFontObject("ChatFontNormal")
jcallahan@249 203 edit_box:SetSize(420, 220)
jcallahan@249 204 edit_box:HighlightText(0)
jcallahan@258 205 edit_box:SetFrameLevel(scroll_frame:GetFrameLevel() - 1)
jcallahan@249 206
jcallahan@249 207 edit_box:SetScript("OnCursorChanged", _G.ScrollingEdit_OnCursorChanged)
jcallahan@249 208 edit_box:SetScript("OnEscapePressed", _G.EditBox_ClearFocus)
jcallahan@249 209 edit_box:SetScript("OnShow", function(self)
jcallahan@249 210 _G.EditBox_SetFocus(self)
jcallahan@249 211
jcallahan@249 212 if self:GetNumLetters() > 0 then
jcallahan@249 213 panel.submitButton:Enable()
jcallahan@249 214 else
jcallahan@249 215 panel.submitButton:Disable()
jcallahan@249 216 end
jcallahan@249 217 end)
jcallahan@249 218
jcallahan@249 219 edit_box:SetScript("OnTextChanged", function(self, user_input)
jcallahan@249 220 local parent = self:GetParent()
jcallahan@249 221 local num_letters = self:GetNumLetters()
jcallahan@249 222 _G.ScrollingEdit_OnTextChanged(self, parent)
jcallahan@258 223 parent.charCount:SetFormattedText(_G.BreakUpLargeNumbers(self:GetMaxLetters() - num_letters))
jcallahan@249 224
jcallahan@249 225 if num_letters > 0 then
jcallahan@249 226 panel.submitButton:Enable();
jcallahan@258 227 else
jcallahan@258 228 panel.submitButton:Disable()
jcallahan@249 229 end
jcallahan@249 230 end)
jcallahan@249 231
jcallahan@249 232 edit_box:SetScript("OnUpdate", function(self, elapsed)
jcallahan@249 233 _G.ScrollingEdit_OnUpdate(self, elapsed, self:GetParent())
jcallahan@249 234 end)
jcallahan@249 235
jcallahan@258 236 edit_container:SetScript("OnMouseUp", function()
jcallahan@258 237 _G.EditBox_SetFocus(edit_box)
jcallahan@258 238 end)
jcallahan@258 239
jcallahan@258 240 scroll_frame.edit_box = edit_box
jcallahan@249 241 scroll_frame:SetScrollChild(edit_box)
jcallahan@249 242
jcallahan@249 243 local char_count = scroll_frame:CreateFontString(nil, "OVERLAY", "GameFontDisableLarge")
jcallahan@249 244 char_count:SetPoint("BOTTOMRIGHT", -15, 0)
jcallahan@249 245 scroll_frame.charCount = char_count
jcallahan@249 246
jcallahan@249 247 local scroll_bar = _G.CreateFrame("Slider", "$parentScrollBar", scroll_frame, "UIPanelScrollBarTemplate")
jcallahan@249 248 scroll_bar:SetPoint("TOPLEFT", scroll_frame, "TOPRIGHT", -13, -16)
jcallahan@249 249 scroll_bar:SetPoint("BOTTOMLEFT", scroll_frame, "BOTTOMRIGHT", -13, 16)
jcallahan@249 250 scroll_frame.ScrollBar = scroll_bar
jcallahan@249 251
jcallahan@249 252 _G.ScrollFrame_OnLoad(scroll_frame)
jcallahan@249 253
jcallahan@249 254 local submit = _G.CreateFrame("Button", "$parentSubmit", panel, "GameMenuButtonTemplate")
jcallahan@249 255 submit:SetSize(160, 30)
jcallahan@249 256 submit:SetPoint("BOTTOM", 0, 15)
jcallahan@249 257 submit:SetText(_G.SUBMIT)
jcallahan@249 258 submit:Enable(false)
jcallahan@249 259
jcallahan@249 260 submit:SetScript("OnClick", function()
jcallahan@263 261 local entry = DBEntry(URL_TYPE_MAP[comment_subject.type_name], comment_subject.id)
jcallahan@263 262
jcallahan@263 263 if not entry then
jcallahan@263 264 WDP:Print("An error has occurred; please report at http://wow.curseforge.com/addons/wowdb-profiler/create-ticket/")
jcallahan@263 265 return
jcallahan@263 266 end
jcallahan@263 267 entry.comments = entry.comments or {}
jcallahan@263 268 entry.comments[#entry.comments + 1] = edit_box:GetText()
jcallahan@263 269
jcallahan@249 270 edit_box:SetText("")
jcallahan@249 271 _G.HideUIPanel(panel)
jcallahan@249 272 end)
jcallahan@249 273 panel.submitButton = submit
jcallahan@249 274 end
jcallahan@249 275
jcallahan@260 276 local function CreateUnitComment(unit_id)
jcallahan@260 277 if not _G.UnitExists(unit_id) then
jcallahan@260 278 WDP:Printf("Unit '%s' does not exist.", unit_id)
jcallahan@260 279 return
jcallahan@260 280 end
jcallahan@260 281 local unit_type, unit_idnum = ParseGUID(_G.UnitGUID(unit_id))
jcallahan@260 282
jcallahan@260 283 if not unit_idnum then
jcallahan@260 284 WDP:Printf("Unable to determine unit from '%s'", unit_id)
jcallahan@260 285 return
jcallahan@260 286 end
jcallahan@259 287 local type_name = private.UNIT_TYPE_NAMES[unit_type + 1]
jcallahan@259 288 local unit_name = _G.UnitName(unit_id)
jcallahan@259 289 comment_subject.type_name = type_name
jcallahan@259 290 comment_subject.id = unit_idnum
jcallahan@259 291 comment_subject.label = unit_name
jcallahan@259 292
jcallahan@259 293 comment_frame.subject_name:SetText(unit_name)
jcallahan@259 294 comment_frame.subject_data:SetFormattedText("(%s #%d)", type_name, unit_idnum)
jcallahan@258 295 comment_frame.scroll_frame.edit_box:SetText("")
jcallahan@262 296 _G.ShowUIPanel(comment_frame)
jcallahan@249 297 end
jcallahan@249 298
jcallahan@260 299 local DATA_TYPE_MAPPING = {
jcallahan@260 300 merchant = "ITEM",
jcallahan@260 301 }
jcallahan@260 302
jcallahan@260 303 local CURSOR_DATA_FUNCS = {
jcallahan@260 304 item = function(data_type, data, data_subtype)
jcallahan@260 305 local item_name = _G.GetItemInfo(data)
jcallahan@260 306 comment_subject.type_name = data_type
jcallahan@260 307 comment_subject.id = data
jcallahan@260 308 comment_subject.label = item_name
jcallahan@260 309
jcallahan@260 310 comment_frame.subject_name:SetText(item_name)
jcallahan@260 311 comment_frame.subject_data:SetFormattedText("(%s #%d)", data_type, data)
jcallahan@260 312 end,
jcallahan@260 313 merchant = function(data_type, data)
jcallahan@260 314 local item_link = _G.GetMerchantItemLink(data)
jcallahan@260 315 local item_name = _G.GetItemInfo(item_link)
jcallahan@260 316 local item_id = ItemLinkToID(item_link)
jcallahan@260 317 comment_subject.type_name = data_type
jcallahan@260 318 comment_subject.id = item_id
jcallahan@260 319 comment_subject.label = item_name
jcallahan@260 320
jcallahan@260 321 comment_frame.subject_name:SetText(item_name)
jcallahan@260 322 comment_frame.subject_data:SetFormattedText("(%s #%d)", data_type, item_id)
jcallahan@260 323 end,
jcallahan@260 324 spell = function(data_type, data, data_subtype, subdata)
jcallahan@260 325 local spell_name = _G.GetSpellInfo(subdata)
jcallahan@260 326 comment_subject.type_name = data_type
jcallahan@260 327 comment_subject.id = subdata
jcallahan@260 328 comment_subject.label = spell_name
jcallahan@260 329
jcallahan@260 330 comment_frame.subject_name:SetText(spell_name)
jcallahan@260 331 comment_frame.subject_data:SetFormattedText("(%s #%d)", data_type, subdata)
jcallahan@260 332 end,
jcallahan@260 333 }
jcallahan@260 334
jcallahan@249 335 local function CreateCursorComment()
jcallahan@260 336 local data_type, data, data_subtype, subdata = _G.GetCursorInfo()
jcallahan@260 337
jcallahan@260 338 if not CURSOR_DATA_FUNCS[data_type] then
jcallahan@260 339 WDP:Print("Unable to determine comment subject from cursor.")
jcallahan@260 340 return
jcallahan@260 341 end
jcallahan@260 342 CURSOR_DATA_FUNCS[data_type](DATA_TYPE_MAPPING[data_type] or data_type:upper(), data, data_subtype, subdata)
jcallahan@260 343 comment_frame.scroll_frame.edit_box:SetText("")
jcallahan@262 344 _G.ShowUIPanel(comment_frame)
jcallahan@249 345 end
jcallahan@249 346
jcallahan@261 347 local function CreateQuestComment()
jcallahan@261 348 local index = _G.GetQuestLogSelection()
jcallahan@261 349
jcallahan@261 350 if not index or not _G.QuestLogFrame:IsShown() then
jcallahan@261 351 WDP:Print("You must select a quest from the Quest frame.")
jcallahan@261 352 return
jcallahan@261 353 end
jcallahan@261 354 local title, _, tag, _, is_header, _, _, _, idnum = _G.GetQuestLogTitle(index)
jcallahan@261 355
jcallahan@261 356 if is_header then
jcallahan@261 357 WDP:Print("You must select a quest from the Quest frame.")
jcallahan@261 358 return
jcallahan@261 359 end
jcallahan@261 360 comment_subject.type_name = "QUEST"
jcallahan@261 361 comment_subject.id = idnum
jcallahan@261 362 comment_subject.label = title
jcallahan@261 363
jcallahan@261 364 comment_frame.subject_name:SetText(title)
jcallahan@261 365 comment_frame.subject_data:SetFormattedText("(%s #%d)", "QUEST", idnum)
jcallahan@261 366 comment_frame.scroll_frame.edit_box:SetText("")
jcallahan@262 367 _G.ShowUIPanel(comment_frame)
jcallahan@261 368 end
jcallahan@261 369
jcallahan@249 370 -- METHODS ------------------------------------------------------------
jcallahan@249 371
jcallahan@249 372 function private.ProcessCommentCommand(arg)
jcallahan@249 373 if not arg or arg == "" then
jcallahan@249 374 WDP:Print("You must supply a valid comment type.")
jcallahan@249 375 return
jcallahan@249 376 end
jcallahan@249 377
jcallahan@249 378 if arg == "cursor" then
jcallahan@260 379 CreateCursorComment()
jcallahan@249 380 return
jcallahan@261 381 elseif arg == "quest" then
jcallahan@261 382 CreateQuestComment()
jcallahan@261 383 return
jcallahan@249 384 end
jcallahan@260 385 CreateUnitComment(arg)
jcallahan@249 386 end