b465d101aecb3ef85b635f906c27b1d5037eb300
[WebKit-https.git] / Source / WebCore / html / HTMLTextAreaElement.cpp
1 /*
2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
4  *           (C) 2001 Dirk Mueller (mueller@kde.org)
5  * Copyright (C) 2004, 2005, 2006, 2007, 2008, 2010 Apple Inc. All rights reserved.
6  *           (C) 2006 Alexey Proskuryakov (ap@nypop.com)
7  * Copyright (C) 2007 Samuel Weinig (sam@webkit.org)
8  *
9  * This library is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Library General Public
11  * License as published by the Free Software Foundation; either
12  * version 2 of the License, or (at your option) any later version.
13  *
14  * This library is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  * Library General Public License for more details.
18  *
19  * You should have received a copy of the GNU Library General Public License
20  * along with this library; see the file COPYING.LIB.  If not, write to
21  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
22  * Boston, MA 02110-1301, USA.
23  *
24  */
25
26 #include "config.h"
27 #include "HTMLTextAreaElement.h"
28
29 #include "Attribute.h"
30 #include "BeforeTextInsertedEvent.h"
31 #include "CSSValueKeywords.h"
32 #include "Document.h"
33 #include "Editor.h"
34 #include "Event.h"
35 #include "EventHandler.h"
36 #include "EventNames.h"
37 #include "ExceptionCode.h"
38 #include "ExceptionCodePlaceholder.h"
39 #include "FormController.h"
40 #include "FormDataList.h"
41 #include "Frame.h"
42 #include "FrameSelection.h"
43 #include "HTMLNames.h"
44 #include "LocalizedStrings.h"
45 #include "RenderTextControlMultiLine.h"
46 #include "ShadowRoot.h"
47 #include "Text.h"
48 #include "TextBreakIterator.h"
49 #include "TextControlInnerElements.h"
50 #include "TextNodeTraversal.h"
51 #include <wtf/Ref.h>
52 #include <wtf/StdLibExtras.h>
53 #include <wtf/text/StringBuilder.h>
54
55 namespace WebCore {
56
57 using namespace HTMLNames;
58
59 static const int defaultRows = 2;
60 static const int defaultCols = 20;
61
62 // On submission, LF characters are converted into CRLF.
63 // This function returns number of characters considering this.
64 static inline unsigned computeLengthForSubmission(const String& text, unsigned numberOfLineBreaks)
65 {
66     return numGraphemeClusters(text) + numberOfLineBreaks;
67 }
68
69 static unsigned numberOfLineBreaks(const String& text)
70 {
71     unsigned length = text.length();
72     unsigned count = 0;
73     for (unsigned i = 0; i < length; i++) {
74         if (text[i] == '\n')
75             count++;
76     }
77     return count;
78 }
79
80 static inline unsigned computeLengthForSubmission(const String& text)
81 {
82     return numGraphemeClusters(text) + numberOfLineBreaks(text);
83 }
84
85 static inline unsigned upperBoundForLengthForSubmission(const String& text, unsigned numberOfLineBreaks)
86 {
87     return text.length() + numberOfLineBreaks;
88 }
89
90 HTMLTextAreaElement::HTMLTextAreaElement(const QualifiedName& tagName, Document& document, HTMLFormElement* form)
91     : HTMLTextFormControlElement(tagName, document, form)
92     , m_rows(defaultRows)
93     , m_cols(defaultCols)
94     , m_wrap(SoftWrap)
95     , m_placeholder(0)
96     , m_isDirty(false)
97     , m_wasModifiedByUser(false)
98 {
99     ASSERT(hasTagName(textareaTag));
100     setFormControlValueMatchesRenderer(true);
101 }
102
103 PassRefPtr<HTMLTextAreaElement> HTMLTextAreaElement::create(const QualifiedName& tagName, Document& document, HTMLFormElement* form)
104 {
105     RefPtr<HTMLTextAreaElement> textArea = adoptRef(new HTMLTextAreaElement(tagName, document, form));
106     textArea->ensureUserAgentShadowRoot();
107     return textArea.release();
108 }
109
110 void HTMLTextAreaElement::didAddUserAgentShadowRoot(ShadowRoot* root)
111 {
112     root->appendChild(TextControlInnerTextElement::create(document()), ASSERT_NO_EXCEPTION);
113 }
114
115 const AtomicString& HTMLTextAreaElement::formControlType() const
116 {
117     DEFINE_STATIC_LOCAL(const AtomicString, textarea, ("textarea", AtomicString::ConstructFromLiteral));
118     return textarea;
119 }
120
121 FormControlState HTMLTextAreaElement::saveFormControlState() const
122 {
123     return m_isDirty ? FormControlState(value()) : FormControlState();
124 }
125
126 void HTMLTextAreaElement::restoreFormControlState(const FormControlState& state)
127 {
128     setValue(state[0]);
129 }
130
131 void HTMLTextAreaElement::childrenChanged(const ChildChange& change)
132 {
133     HTMLElement::childrenChanged(change);
134     setLastChangeWasNotUserEdit();
135     if (m_isDirty)
136         setInnerTextValue(value());
137     else
138         setNonDirtyValue(defaultValue());
139 }
140
141 bool HTMLTextAreaElement::isPresentationAttribute(const QualifiedName& name) const
142 {
143     if (name == alignAttr) {
144         // Don't map 'align' attribute.  This matches what Firefox, Opera and IE do.
145         // See http://bugs.webkit.org/show_bug.cgi?id=7075
146         return false;
147     }
148
149     if (name == wrapAttr)
150         return true;
151     return HTMLTextFormControlElement::isPresentationAttribute(name);
152 }
153
154 void HTMLTextAreaElement::collectStyleForPresentationAttribute(const QualifiedName& name, const AtomicString& value, MutableStyleProperties& style)
155 {
156     if (name == wrapAttr) {
157         if (shouldWrapText()) {
158             addPropertyToPresentationAttributeStyle(style, CSSPropertyWhiteSpace, CSSValuePreWrap);
159             addPropertyToPresentationAttributeStyle(style, CSSPropertyWordWrap, CSSValueBreakWord);
160         } else {
161             addPropertyToPresentationAttributeStyle(style, CSSPropertyWhiteSpace, CSSValuePre);
162             addPropertyToPresentationAttributeStyle(style, CSSPropertyWordWrap, CSSValueNormal);
163         }
164     } else
165         HTMLTextFormControlElement::collectStyleForPresentationAttribute(name, value, style);
166 }
167
168 void HTMLTextAreaElement::parseAttribute(const QualifiedName& name, const AtomicString& value)
169 {
170     if (name == rowsAttr) {
171         int rows = value.toInt();
172         if (rows <= 0)
173             rows = defaultRows;
174         if (m_rows != rows) {
175             m_rows = rows;
176             if (renderer())
177                 renderer()->setNeedsLayoutAndPrefWidthsRecalc();
178         }
179     } else if (name == colsAttr) {
180         int cols = value.toInt();
181         if (cols <= 0)
182             cols = defaultCols;
183         if (m_cols != cols) {
184             m_cols = cols;
185             if (renderer())
186                 renderer()->setNeedsLayoutAndPrefWidthsRecalc();
187         }
188     } else if (name == wrapAttr) {
189         // The virtual/physical values were a Netscape extension of HTML 3.0, now deprecated.
190         // The soft/hard /off values are a recommendation for HTML 4 extension by IE and NS 4.
191         WrapMethod wrap;
192         if (equalIgnoringCase(value, "physical") || equalIgnoringCase(value, "hard") || equalIgnoringCase(value, "on"))
193             wrap = HardWrap;
194         else if (equalIgnoringCase(value, "off"))
195             wrap = NoWrap;
196         else
197             wrap = SoftWrap;
198         if (wrap != m_wrap) {
199             m_wrap = wrap;
200             if (renderer())
201                 renderer()->setNeedsLayoutAndPrefWidthsRecalc();
202         }
203     } else if (name == accesskeyAttr) {
204         // ignore for the moment
205     } else if (name == maxlengthAttr)
206         setNeedsValidityCheck();
207     else
208         HTMLTextFormControlElement::parseAttribute(name, value);
209 }
210
211 RenderPtr<RenderElement> HTMLTextAreaElement::createElementRenderer(PassRef<RenderStyle> style)
212 {
213     return createRenderer<RenderTextControlMultiLine>(*this, std::move(style));
214 }
215
216 bool HTMLTextAreaElement::appendFormData(FormDataList& encoding, bool)
217 {
218     if (name().isEmpty())
219         return false;
220
221     document().updateLayout();
222
223     const String& text = (m_wrap == HardWrap) ? valueWithHardLineBreaks() : value();
224     encoding.appendData(name(), text);
225
226     const AtomicString& dirnameAttrValue = fastGetAttribute(dirnameAttr);
227     if (!dirnameAttrValue.isNull())
228         encoding.appendData(dirnameAttrValue, directionForFormData());
229     return true;    
230 }
231
232 void HTMLTextAreaElement::reset()
233 {
234     setNonDirtyValue(defaultValue());
235 }
236
237 bool HTMLTextAreaElement::hasCustomFocusLogic() const
238 {
239     return true;
240 }
241
242 bool HTMLTextAreaElement::isKeyboardFocusable(KeyboardEvent*) const
243 {
244     // If a given text area can be focused at all, then it will always be keyboard focusable.
245     return isFocusable();
246 }
247
248 bool HTMLTextAreaElement::isMouseFocusable() const
249 {
250     return isFocusable();
251 }
252
253 void HTMLTextAreaElement::updateFocusAppearance(bool restorePreviousSelection)
254 {
255     if (!restorePreviousSelection || !hasCachedSelection()) {
256         // If this is the first focus, set a caret at the beginning of the text.  
257         // This matches some browsers' behavior; see bug 11746 Comment #15.
258         // http://bugs.webkit.org/show_bug.cgi?id=11746#c15
259         setSelectionRange(0, 0);
260     } else
261         restoreCachedSelection();
262
263     if (document().frame())
264         document().frame()->selection().revealSelection();
265 }
266
267 void HTMLTextAreaElement::defaultEventHandler(Event* event)
268 {
269     if (renderer() && (event->isMouseEvent() || event->isDragEvent() || event->eventInterface() == WheelEventInterfaceType || event->type() == eventNames().blurEvent))
270         forwardEvent(event);
271     else if (renderer() && event->isBeforeTextInsertedEvent())
272         handleBeforeTextInsertedEvent(static_cast<BeforeTextInsertedEvent*>(event));
273
274     HTMLTextFormControlElement::defaultEventHandler(event);
275 }
276
277 void HTMLTextAreaElement::subtreeHasChanged()
278 {
279     setChangedSinceLastFormControlChangeEvent(true);
280     setFormControlValueMatchesRenderer(false);
281     setNeedsValidityCheck();
282
283     if (!focused())
284         return;
285
286     if (Frame* frame = document().frame())
287         frame->editor().textDidChangeInTextArea(this);
288     // When typing in a textarea, childrenChanged is not called, so we need to force the directionality check.
289     calculateAndAdjustDirectionality();
290 }
291
292 void HTMLTextAreaElement::handleBeforeTextInsertedEvent(BeforeTextInsertedEvent* event) const
293 {
294     ASSERT(event);
295     ASSERT(renderer());
296     int signedMaxLength = maxLength();
297     if (signedMaxLength < 0)
298         return;
299     unsigned unsignedMaxLength = static_cast<unsigned>(signedMaxLength);
300
301     const String& currentValue = innerTextValue();
302     unsigned numberOfLineBreaksInCurrentValue = numberOfLineBreaks(currentValue);
303     if (upperBoundForLengthForSubmission(currentValue, numberOfLineBreaksInCurrentValue)
304         + upperBoundForLengthForSubmission(event->text(), numberOfLineBreaks(event->text())) < unsignedMaxLength)
305         return;
306
307     unsigned currentLength = computeLengthForSubmission(currentValue, numberOfLineBreaksInCurrentValue);
308     // selectionLength represents the selection length of this text field to be
309     // removed by this insertion.
310     // If the text field has no focus, we don't need to take account of the
311     // selection length. The selection is the source of text drag-and-drop in
312     // that case, and nothing in the text field will be removed.
313     unsigned selectionLength = focused() ? computeLengthForSubmission(plainText(document().frame()->selection().selection().toNormalizedRange().get())) : 0;
314     ASSERT(currentLength >= selectionLength);
315     unsigned baseLength = currentLength - selectionLength;
316     unsigned appendableLength = unsignedMaxLength > baseLength ? unsignedMaxLength - baseLength : 0;
317     event->setText(sanitizeUserInputValue(event->text(), appendableLength));
318 }
319
320 String HTMLTextAreaElement::sanitizeUserInputValue(const String& proposedValue, unsigned maxLength)
321 {
322     return proposedValue.left(numCharactersInGraphemeClusters(proposedValue, maxLength));
323 }
324
325 TextControlInnerTextElement* HTMLTextAreaElement::innerTextElement() const
326 {
327     Node* node = userAgentShadowRoot()->firstChild();
328     return toTextControlInnerTextElement(node);
329 }
330
331 void HTMLTextAreaElement::rendererWillBeDestroyed()
332 {
333     updateValue();
334 }
335
336 void HTMLTextAreaElement::updateValue() const
337 {
338     if (formControlValueMatchesRenderer())
339         return;
340
341     ASSERT(renderer());
342     m_value = innerTextValue();
343     const_cast<HTMLTextAreaElement*>(this)->setFormControlValueMatchesRenderer(true);
344     const_cast<HTMLTextAreaElement*>(this)->notifyFormStateChanged();
345     m_isDirty = true;
346     m_wasModifiedByUser = true;
347     const_cast<HTMLTextAreaElement*>(this)->updatePlaceholderVisibility(false);
348 }
349
350 String HTMLTextAreaElement::value() const
351 {
352     updateValue();
353     return m_value;
354 }
355
356 void HTMLTextAreaElement::setValue(const String& value)
357 {
358     setValueCommon(value);
359     m_isDirty = true;
360     setNeedsValidityCheck();
361 }
362
363 void HTMLTextAreaElement::setNonDirtyValue(const String& value)
364 {
365     setValueCommon(value);
366     m_isDirty = false;
367     setNeedsValidityCheck();
368 }
369
370 void HTMLTextAreaElement::setValueCommon(const String& newValue)
371 {
372     m_wasModifiedByUser = false;
373     // Code elsewhere normalizes line endings added by the user via the keyboard or pasting.
374     // We normalize line endings coming from JavaScript here.
375     String normalizedValue = newValue.isNull() ? "" : newValue;
376     normalizedValue.replace("\r\n", "\n");
377     normalizedValue.replace('\r', '\n');
378
379     // Return early because we don't want to move the caret or trigger other side effects
380     // when the value isn't changing. This matches Firefox behavior, at least.
381     if (normalizedValue == value())
382         return;
383
384     m_value = normalizedValue;
385     setInnerTextValue(m_value);
386     setLastChangeWasNotUserEdit();
387     updatePlaceholderVisibility(false);
388     setNeedsStyleRecalc();
389     setFormControlValueMatchesRenderer(true);
390
391     // Set the caret to the end of the text value.
392     if (document().focusedElement() == this) {
393         unsigned endOfString = m_value.length();
394         setSelectionRange(endOfString, endOfString);
395     }
396
397     notifyFormStateChanged();
398     setTextAsOfLastFormControlChangeEvent(normalizedValue);
399 }
400
401 String HTMLTextAreaElement::defaultValue() const
402 {
403     return TextNodeTraversal::contentsAsString(this);
404 }
405
406 void HTMLTextAreaElement::setDefaultValue(const String& defaultValue)
407 {
408     Ref<HTMLTextAreaElement> protectFromMutationEvents(*this);
409
410     // To preserve comments, remove only the text nodes, then add a single text node.
411     Vector<RefPtr<Text>> textNodes;
412     for (Text* textNode = TextNodeTraversal::firstChild(this); textNode; textNode = TextNodeTraversal::nextSibling(textNode))
413         textNodes.append(textNode);
414
415     size_t size = textNodes.size();
416     for (size_t i = 0; i < size; ++i)
417         removeChild(textNodes[i].get(), IGNORE_EXCEPTION);
418
419     // Normalize line endings.
420     String value = defaultValue;
421     value.replace("\r\n", "\n");
422     value.replace('\r', '\n');
423
424     insertBefore(document().createTextNode(value), firstChild(), IGNORE_EXCEPTION);
425
426     if (!m_isDirty)
427         setNonDirtyValue(value);
428 }
429
430 int HTMLTextAreaElement::maxLength() const
431 {
432     bool ok;
433     int value = getAttribute(maxlengthAttr).string().toInt(&ok);
434     return ok && value >= 0 ? value : -1;
435 }
436
437 void HTMLTextAreaElement::setMaxLength(int newValue, ExceptionCode& ec)
438 {
439     if (newValue < 0)
440         ec = INDEX_SIZE_ERR;
441     else
442         setIntegralAttribute(maxlengthAttr, newValue);
443 }
444
445 String HTMLTextAreaElement::validationMessage() const
446 {
447     if (!willValidate())
448         return String();
449
450     if (customError())
451         return customValidationMessage();
452
453     if (valueMissing())
454         return validationMessageValueMissingText();
455
456     if (tooLong())
457         return validationMessageTooLongText(computeLengthForSubmission(value()), maxLength());
458
459     return String();
460 }
461
462 bool HTMLTextAreaElement::valueMissing() const
463 {
464     return willValidate() && valueMissing(value());
465 }
466
467 bool HTMLTextAreaElement::tooLong() const
468 {
469     return willValidate() && tooLong(value(), CheckDirtyFlag);
470 }
471
472 bool HTMLTextAreaElement::tooLong(const String& value, NeedsToCheckDirtyFlag check) const
473 {
474     // Return false for the default value or value set by script even if it is
475     // longer than maxLength.
476     if (check == CheckDirtyFlag && !m_wasModifiedByUser)
477         return false;
478
479     int max = maxLength();
480     if (max < 0)
481         return false;
482     unsigned unsignedMax = static_cast<unsigned>(max);
483     unsigned numberOfLineBreaksInValue = numberOfLineBreaks(value);
484     return upperBoundForLengthForSubmission(value, numberOfLineBreaksInValue) > unsignedMax
485         && computeLengthForSubmission(value, numberOfLineBreaksInValue) > unsignedMax;
486 }
487
488 bool HTMLTextAreaElement::isValidValue(const String& candidate) const
489 {
490     return !valueMissing(candidate) && !tooLong(candidate, IgnoreDirtyFlag);
491 }
492
493 void HTMLTextAreaElement::accessKeyAction(bool)
494 {
495     focus();
496 }
497
498 void HTMLTextAreaElement::setCols(int cols)
499 {
500     setIntegralAttribute(colsAttr, cols);
501 }
502
503 void HTMLTextAreaElement::setRows(int rows)
504 {
505     setIntegralAttribute(rowsAttr, rows);
506 }
507
508 bool HTMLTextAreaElement::shouldUseInputMethod()
509 {
510     return true;
511 }
512
513 HTMLElement* HTMLTextAreaElement::placeholderElement() const
514 {
515     return m_placeholder;
516 }
517
518 bool HTMLTextAreaElement::matchesReadOnlyPseudoClass() const
519 {
520     return isReadOnly();
521 }
522
523 bool HTMLTextAreaElement::matchesReadWritePseudoClass() const
524 {
525     return !isDisabledOrReadOnly();
526 }
527
528 void HTMLTextAreaElement::updatePlaceholderText()
529 {
530     String placeholderText = strippedPlaceholder();
531     if (placeholderText.isEmpty()) {
532         if (m_placeholder) {
533             userAgentShadowRoot()->removeChild(m_placeholder, ASSERT_NO_EXCEPTION);
534             m_placeholder = 0;
535         }
536         return;
537     }
538     if (!m_placeholder) {
539         RefPtr<HTMLDivElement> placeholder = HTMLDivElement::create(document());
540         m_placeholder = placeholder.get();
541         m_placeholder->setPseudo(AtomicString("-webkit-input-placeholder", AtomicString::ConstructFromLiteral));
542         userAgentShadowRoot()->insertBefore(m_placeholder, innerTextElement()->nextSibling());
543     }
544     m_placeholder->setInnerText(placeholderText, ASSERT_NO_EXCEPTION);
545 }
546
547 bool HTMLTextAreaElement::willRespondToMouseClickEvents()
548 {
549     return !isDisabledFormControl();
550 }
551
552 } // namespace WebCore